/usr/include/openturns/swig/BlendedStep_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 | %feature("docstring") OT::BlendedStep
"Blended step.
Available constructors:
BlendedStep(*epsilon, eta=1.*)
Parameters
----------
epsilon : sequence of float
Finite difference step factors for each dimension.
eta : positive float, sequence of positive float with the same dimension as *epsilon*
Finite difference step offsets for each dimension.
Notes
-----
*BlendedStep* defines a list of finite difference steps equal to:
*epsilon (|x| + eta)*.
See also
--------
ConstantStep
Examples
--------
>>> import openturns as ot
>>> epsilon = [1e-4, 2e-4]
>>> x = [2.]*2
>>> steps = ot.BlendedStep(epsilon)
>>> print(steps(x))
[0.0003,0.0006]
>>> steps = ot.BlendedStep(epsilon, 0.)
>>> print(steps(x))
[0.0002,0.0004]
>>> steps = ot.BlendedStep(epsilon, [1., 2.])
>>> print(steps(x))
[0.0003,0.0008]
>>> steps = ot.BlendedStep(epsilon, 2.)
>>> print(steps(x))
[0.0004,0.0008]"
// ---------------------------------------------------------------------
%feature("docstring") OT::BlendedStep::getEta
"Get the finite difference step offsets.
Returns
-------
eta : :class:`~openturns.NumericalPoint`
Finite difference step offsets for each dimension."
// ---------------------------------------------------------------------
%feature("docstring") OT::BlendedStep::setEta
"Set the finite difference step offsets.
Parameters
----------
eta : sequence of positive float
Finite difference step offsets for each dimension."
|