/usr/include/openturns/swig/FiniteDifferenceStepImplementation_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 | %define OT_FiniteDifferenceStep_doc
"Base class to define finite difference steps.
Available constructors:
FiniteDifferenceStep(*epsilon=[1.0]*)
Parameters
----------
epsilon : sequence of float
Finite difference steps for each dimension.
Notes
-----
Base class to define how finite difference steps are computed.
Using *FiniteDifferenceStep* is equivalent to use its derived class
:class:`~openturns.ConstantStep`. Another way to compute steps
is through its second derived class :class:`~openturns.BlendedStep`."
%enddef
%feature("docstring") OT::FiniteDifferenceStepImplementation
OT_FiniteDifferenceStep_doc
// ---------------------------------------------------------------------
%define OT_FiniteDifferenceStep_getEpsilon_doc
"Get the finite difference steps.
Returns
-------
epsilon : :class:`~openturns.NumericalPoint`
If :class:`~openturns.ConstantStep` : Finite difference steps for each
dimension.
If :class:`~openturns.BlendedStep` : Finite difference step factors for
each dimension."
%enddef
%feature("docstring") OT::FiniteDifferenceStepImplementation::getEpsilon
OT_FiniteDifferenceStep_getEpsilon_doc
// ---------------------------------------------------------------------
%define OT_FiniteDifferenceStep_setEpsilon_doc
"Set the finite difference steps.
Parameters
----------
epsilon : sequence of float
If :class:`~openturns.ConstantStep` : Finite difference steps for each
dimension.
If :class:`~openturns.BlendedStep` : Finite difference step factors for
each dimension."
%enddef
%feature("docstring") OT::FiniteDifferenceStepImplementation::setEpsilon
OT_FiniteDifferenceStep_setEpsilon_doc
|