/usr/include/openturns/swig/Pairs_doc.i is in libopenturns-dev 1.7-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 | %feature("docstring") OT::Pairs
"Pairs.
Available constructors:
Pairs(*data, title=' '*)
Pairs(*data, title, labels, color, pointStyle*)
Parameters
----------
data : 2-d sequence of float of dimension :math:`n`
Points from which 2D clouds are built.
title : str
Title of the Pairs.
labels : sequence of str of dimension :math:`n`
Names of each component of the sample.
color : str
Color of the points. If not specified, by default it is 'blue'.
pointStyle : str
Style of the points. If not specified, by default it is 'plus'.
Examples
--------
>>> import openturns as ot
>>> R = ot.CorrelationMatrix(3)
>>> R[1, 0] = -0.4
>>> R[2, 1] = -0.4
>>> distribution = ot.Normal([0.] * 3, [5.] * 3, R)
>>> sample = distribution.getSample(100)
>>> # Create an empty graph
>>> myGraph = ot.Graph('Pairs', ' ', ' ', True, '')
>>> # Create the Pairs
>>> myPairs = ot.Pairs(sample, 'Pairs example', sample.getDescription(), 'blue', 'bullet')
>>> myGraph.add(myPairs)"
// ---------------------------------------------------------------------
%feature("docstring") OT::Pairs::buildDefaultLabels
"Build default labels by taking the column number of *data*."
// ---------------------------------------------------------------------
%feature("docstring") OT::Pairs::getTitle
"Get the title of the Pairs.
Returns
-------
title : str
Title of the Pairs."
// ---------------------------------------------------------------------
%feature("docstring") OT::Pairs::setTitle
"Set the title of the Pairs.
Parameters
----------
title : str
Title of the Pairs."
|