/usr/include/openturns/swig/GradientImplementation_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 | %feature("docstring") OT::GradientImplementation
"Numerical math gradient implementation.
See also
--------
Function, HessianImplementation
Notes
-----
This object is the result of the method *getGradient* of a
:class:`~openturns.Function`."
// ---------------------------------------------------------------------
%feature("docstring") OT::GradientImplementation::getCallsNumber
"Accessor to the number of times the gradient has been called.
Returns
-------
calls_number : int
Integer that counts the number of times the gradient has been called
since its creation."
// ---------------------------------------------------------------------
%feature("docstring") OT::GradientImplementation::getInputDimension
"Accessor to the number of the inputs.
Returns
-------
number_inputs : int
Number of inputs."
// ---------------------------------------------------------------------
%feature("docstring") OT::GradientImplementation::getOutputDimension
"Accessor to the number of the outputs.
Returns
-------
number_outputs : int
Number of outputs."
// ---------------------------------------------------------------------
%feature("docstring") OT::GradientImplementation::getMarginal
"Accessor to the gradient implementation of a specific output.
Parameters
----------
i : integer
Integer corresponding to the output (Care: it starts at 0).
indices : sequence of integer
The set of indices for which the outputs are extracted.
Returns
-------
gradientImplementation : :class:`~openturns.GradientImplementation`
A gradient implementation restricted to its compenents functions which
indices are *i* or *indices*."
// ---------------------------------------------------------------------
%feature("docstring") OT::GradientImplementation::gradient
"Return the Jacobian transposed matrix of the implementation at a point.
Parameters
----------
point : sequence of float
Point where the Jacobian transposed matrix is calculated.
Returns
-------
gradient : :class:`~openturns.Matrix`
The Jacobian transposed matrix of the function at *point*."
// ---------------------------------------------------------------------
%feature("docstring") OT::GradientImplementation::isActualImplementation
"Accessor to the validity flag.
Returns
-------
is_impl : bool
Whether the implementation is valid."
// ---------------------------------------------------------------------
%feature("docstring") OT::GradientImplementation::getParameter
"Accessor to the parameter values.
Returns
-------
parameter : :class:`~openturns.Point`
The parameter values."
// ---------------------------------------------------------------------
%feature("docstring") OT::GradientImplementation::setParameter
"Accessor to the parameter values.
Parameters
----------
parameter : sequence of float
The parameter values."
|