/usr/include/openturns/swig/BasisImplementation_doc.i is in libopenturns-dev 1.9-5.
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 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 | %define OT_Basis_doc
"Basis.
Available constructors:
Basis(*functionsColl*)
Basis(*size*)
Parameters
----------
functionsColl : list of :class:`~openturns.Function`
Functions constituting the Basis.
size : int
Size of the Basis.
Examples
--------
>>> import openturns as ot
>>> dimension = 3
>>> input = ['x0', 'x1', 'x2']
>>> functions = []
>>> for i in range(dimension):
... functions.append(ot.SymbolicFunction(input, [input[i]]))
>>> basis = ot.Basis(functions)"
%enddef
%feature("docstring") OT::BasisImplementation
OT_Basis_doc
// ---------------------------------------------------------------------
%define OT_Basis_add_doc
"Add an element in the Basis.
Parameters
----------
function : :class:`~openturns.Function`
Function added in the Basis.
Examples
--------
>>> import openturns as ot
>>> dimension = 3
>>> input = ['x0', 'x1', 'x2']
>>> functions = []
>>> for i in range(2):
... functions.append(ot.SymbolicFunction(input, [input[i]]))
>>> basis = ot.Basis(functions)
>>> basis.add(ot.SymbolicFunction(input, [input[2]]))"
%enddef
%feature("docstring") OT::BasisImplementation::add
OT_Basis_add_doc
// ---------------------------------------------------------------------
%define OT_Basis_build_doc
"Build the element of the given index.
Parameters
----------
index : int, :math:`index \\\\geq 0`
Index of an element of the Basis.
Returns
-------
function : :class:`~openturns.Function`
The function at the index *index* of the Basis.
Examples
--------
>>> import openturns as ot
>>> dimension = 3
>>> input = ['x0', 'x1', 'x2']
>>> functions = []
>>> for i in range(dimension):
... functions.append(ot.SymbolicFunction(input, [input[i]]))
>>> basis = ot.Basis(functions)
>>> print(basis.build(0).getEvaluation())
[x0,x1,x2]->[x0]"
%enddef
%feature("docstring") OT::BasisImplementation::build
OT_Basis_build_doc
// ---------------------------------------------------------------------
%define OT_Basis_getDimension_doc
"Get the dimension of the Basis.
Returns
-------
dimension : int
Dimension of the Basis."
%enddef
%feature("docstring") OT::BasisImplementation::getDimension
OT_Basis_getDimension_doc
// ---------------------------------------------------------------------
%define OT_Basis_getSize_doc
"Get the size of the Basis.
Returns
-------
size : int
Size of the Basis."
%enddef
%feature("docstring") OT::BasisImplementation::getSize
OT_Basis_getSize_doc
// ---------------------------------------------------------------------
%define OT_Basis_getSubBasis_doc
"Get a sub-basis of the Basis.
Parameters
----------
indices : list of int
Indices of the terms of the Basis put in the sub-basis.
Returns
-------
subBasis : list of :class:`~openturns.Function`
Functions defining a sub-basis.
Examples
--------
>>> import openturns as ot
>>> dimension = 3
>>> input = ['x0', 'x1', 'x2']
>>> functions = []
>>> for i in range(dimension):
... functions.append(ot.SymbolicFunction(input, [input[i]]))
>>> basis = ot.Basis(functions)
>>> subbasis = basis.getSubBasis([1])
>>> print(subbasis[0].getEvaluation())
[x0,x1,x2]->[x1]"
%enddef
%feature("docstring") OT::BasisImplementation::getSubBasis
OT_Basis_getSubBasis_doc
// ---------------------------------------------------------------------
%define OT_Basis_isFunctional_doc
"Tell whether the basis is functional.
Returns
-------
isOrthogonal : bool
`True` if the basis is functional i.e. if its terms are a solution
to an equation (e.g. a basis made up of Legendre functions)."
%enddef
%feature("docstring") OT::BasisImplementation::isFunctional
OT_Basis_isFunctional_doc
// ---------------------------------------------------------------------
%define OT_Basis_isOrthogonal_doc
"Tell whether the basis is orthogonal.
Returns
-------
isOrthogonal : bool
`True` if the basis is orthogonal."
%enddef
%feature("docstring") OT::BasisImplementation::isOrthogonal
OT_Basis_isOrthogonal_doc
|