/usr/include/openturns/swig/FiniteDifferenceHessian_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 | %feature("docstring") OT::FiniteDifferenceHessian
"Base class for second order centered finite-difference scheme.
Available constructors:
FiniteDifferenceHessian(*epsilon, evalImpl*)
FiniteDifferenceHessian(*step, evalImpl*)
Parameters
----------
evalImpl : :class:`~openturns.EvaluationImplementation`
Implementation of the evaluation of a function.
epsilon : float, sequence of float
Finite difference steps for each dimension.
step : :class:`~openturns.FiniteDifferenceStep`
Defines how finite difference steps values are computed.
Notes
-----
Base class to define second order finite-difference scheme. The hessian
can be computed only through its derived class:
- :class:`~openturns.CenteredFiniteDifferenceHessian`."
// ---------------------------------------------------------------------
%feature("docstring") OT::FiniteDifferenceHessian::getInputDimension
"Get the input dimension.
Returns
-------
dimension : int
Input dimension."
// ---------------------------------------------------------------------
%feature("docstring") OT::FiniteDifferenceHessian::getOutputDimension
"Get the output dimension.
Returns
-------
dimension : int
Output dimension."
// ---------------------------------------------------------------------
%feature("docstring") OT::FiniteDifferenceHessian::getEpsilon
"Get the finite difference steps.
Returns
-------
epsilon : :class:`~openturns.Point`
Finite difference steps for each dimension."
// ---------------------------------------------------------------------
%feature("docstring") OT::FiniteDifferenceHessian::getEvaluation
"Get the implementation of the evaluation of the function.
Returns
-------
evalImpl : :class:`~openturns.EvaluationImplementation`
Implementation of the evaluation of a function."
// ---------------------------------------------------------------------
%feature("docstring") OT::FiniteDifferenceHessian::hessian
"Get the hessian at some point.
Parameters
----------
point : sequence of float
Point where the hessian is computed.
Returns
-------
hessian : :class:`~openturns.SymmetricTensor`
Hessian evaluated at *point*."
// ---------------------------------------------------------------------
%feature("docstring") OT::FiniteDifferenceHessian::getFiniteDifferenceStep
"Get the finite difference step.
Returns
-------
step : :class:`~openturns.FiniteDifferenceStep`
Defines how finite difference steps values are computed."
// ---------------------------------------------------------------------
%feature("docstring") OT::FiniteDifferenceHessian::setFiniteDifferenceStep
"Set the finite difference step.
Parameters
----------
step : :class:`~openturns.FiniteDifferenceStep`
Defines how finite difference steps values are computed."
|