/usr/include/openturns/swig/LinearNumericalMathEvaluationImplementation_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 60 61 62 63 64 65 | %feature("docstring") OT::LinearNumericalMathEvaluationImplementation
"Linear numerical math evaluation implementation.
Available constructors:
LinearNumericalMathEvaluationImplementation(*center, constant, linear*)
Parameters
----------
center : sequence of float
Vector :math:`\\\\vect{b}`.
constant : sequence of float
Vector :math:`\\\\vect{c}`.
linear : :class:`~openturns.Matrix`
Matrix :math:`\\\\mat{A}`.
See also
--------
NumericalMathFunction
Notes
-----
This implements a linear :class:`~openturns.NumericalMathFunction` :math:`f`
defined as :
.. math::
f : & \\\\Rset^n \\\\rightarrow \\\\Rset^p \\\\\\\\
& \\\\vect{X} \\\\mapsto \\\\mat{A} ( \\\\vect{X} - \\\\vect{b} ) + \\\\vect{c}
where:
- :math:`\\\\mat{A}` is the :math:`\\\\Rset^p \\\\times \\\\Rset^n` matrix defined by the
input *linear*
- :math:`\\\\vect{b}` is the :math:`\\\\Rset^n` vector defined by the object *center*
- :math:`\\\\vect{c}` is the :math:`\\\\Rset^p` vector defined by the object *constant*."
// ---------------------------------------------------------------------
%feature("docstring") OT::LinearNumericalMathEvaluationImplementation::getCenter
"Accessor to the center.
Returns
-------
center : :class:`~openturns.NumericalPoint`
The center :math:`\\\\vect{b}`."
// ---------------------------------------------------------------------
%feature("docstring") OT::LinearNumericalMathEvaluationImplementation::getConstant
"Accessor to the constant.
Returns
-------
constant : :class:`~openturns.NumericalPoint`
The constant :math:`\\\\vect{c}`."
// ---------------------------------------------------------------------
%feature("docstring") OT::LinearNumericalMathEvaluationImplementation::getLinear
"Accessor to the matrix.
Returns
-------
linear : :class:`~openturns.Matrix`
The matrix :math:`\\\\mat{A}`."
|