/usr/include/openturns/swig/DatabaseNumericalMathEvaluationImplementation_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 66 67 68 69 70 71 72 73 74 75 76 77 78 | %feature("docstring") OT::DatabaseNumericalMathEvaluationImplementation
"Data based math evaluation implementation.
Available constructors:
DatabaseNumericalMathEvaluationImplementation(*inputSample, outputSample*)
DatabaseNumericalMathEvaluationImplementation(*inputSample, outputSample, activateCache*)
Parameters
----------
inputSample : 2-d sequence of float
Sample :math:`\\\\cS^{in}` of size :math:`l` and dimension :math:`n`.
outputSample : 2-d sequence of float
Sample :math:`\\\\cS^{out}` of size :math:`l` and dimension :math:`p`.
activateCache : bool
Flag to enable cache or not.
See also
--------
NumericalMathFunction, AggregatedNumericalMathEvaluationImplementation, DualLinearCombinationEvaluationImplementation,
LinearNumericalMathFunction
Notes
-----
It returns a :class:`~openturns.NumericalMathFunction` that implements a
nearest-neighbor function :math:`f : \\\\Rset^n \\\\rightarrow \\\\Rset^p` based on the
input sample :math:`S^{in}` and taking values in the outputSample :math:`S^{out}`:
.. math::
\\\\forall \\\\vect{x} \\\\in \\\\Rset^n, f(\\\\vect{x}) = y_{i*}
where:
.. math::
i^* = \\\\underset{ \\\\vect{x}_i \\\\in S^{in} }{ \\\\argmin_{i \\\\in \\\\{1, \\\\ldots, l\\\\}} } \\\\|\\\\vect{x} - \\\\vect{x}_i \\\\|
"
// ---------------------------------------------------------------------
%feature("docstring") OT::DatabaseNumericalMathEvaluationImplementation::getInputSample
"Accessor to the input sample defining the functions.
Returns
-------
inputSample : :class:`~openturns.NumericalSample`
The input sample defining the function."
// ---------------------------------------------------------------------
%feature("docstring") OT::DatabaseNumericalMathEvaluationImplementation::getOutputSample
"Accessor to the output sample defining the functions.
Returns
-------
outputSample : :class:`~openturns.NumericalSample`
The output sample defining the function."
// ---------------------------------------------------------------------
%feature("docstring") OT::DatabaseNumericalMathEvaluationImplementation::setInputSample
"Accessor to the input sample defining the functions.
Parameters
----------
inputSample : :class:`~openturns.NumericalSample`
The input sample defining the function."
// ---------------------------------------------------------------------
%feature("docstring") OT::DatabaseNumericalMathEvaluationImplementation::setOutputSample
"Accessor to the output sample defining the functions.
Parameters
----------
outputSample : :class:`~openturns.NumericalSample`
The output sample defining the function."
|