BlendedStep

class BlendedStep(*args)

Blended step.

Available constructors:

BlendedStep(epsilon, eta=1.0)

Parameters

epsilonsequence of float

Finite difference step factors for each dimension.

etapositive float, sequence of positive float with the same dimension as epsilon

Finite difference step offsets for each dimension.

See also

ConstantStep

Notes

BlendedStep defines a list of finite difference steps equal to: epsilon (|x| + eta).

Examples

>>> import openturns as ot
>>> epsilon = [1e-4, 2e-4]
>>> x = [2.0]*2
>>> steps = ot.BlendedStep(epsilon)
>>> print(steps(x))
[0.0003,0.0006]
>>> steps = ot.BlendedStep(epsilon, 0.0)
>>> print(steps(x))
[0.0002,0.0004]
>>> steps = ot.BlendedStep(epsilon, [1.0, 2.0])
>>> print(steps(x))
[0.0003,0.0008]
>>> steps = ot.BlendedStep(epsilon, 2.0)
>>> print(steps(x))
[0.0004,0.0008]

Methods

__call__(self, inP)	Call self as a function.
getClassName(self)	Accessor to the object’s name.
getEpsilon(self)	Get the finite difference steps.
getEta(self)	Get the finite difference step offsets.
getId(self)	Accessor to the object’s id.
getName(self)	Accessor to the object’s name.
getShadowedId(self)	Accessor to the object’s shadowed id.
getVisibility(self)	Accessor to the object’s visibility state.
hasName(self)	Test if the object is named.
hasVisibleName(self)	Test if the object has a distinguishable name.
setEpsilon(self, epsilon)	Set the finite difference steps.
setEta(self, eta)	Set the finite difference step offsets.
setName(self, name)	Accessor to the object’s name.
setShadowedId(self, id)	Accessor to the object’s shadowed id.
setVisibility(self, visible)	Accessor to the object’s visibility state.

__init__(self, \*args)

Initialize self. See help(type(self)) for accurate signature.

getClassName(self)

Accessor to the object’s name.

Returns

class_namestr

The object class name (object.__class__.__name__).

getEpsilon(self)

Get the finite difference steps.

Returns

epsilonPoint

If ConstantStep : Finite difference steps for each dimension.

If BlendedStep : Finite difference step factors for each dimension.

getEta(self)

Get the finite difference step offsets.

Returns

etaPoint

Finite difference step offsets for each dimension.

getId(self)

Accessor to the object’s id.

Returns

idint

Internal unique identifier.

getName(self)

Accessor to the object’s name.

Returns

namestr

The name of the object.

getShadowedId(self)

Accessor to the object’s shadowed id.

Returns

idint

Internal unique identifier.

getVisibility(self)

Accessor to the object’s visibility state.

Returns

visiblebool

Visibility flag.

hasName(self)

Test if the object is named.

Returns

hasNamebool

True if the name is not empty.

hasVisibleName(self)

Test if the object has a distinguishable name.

Returns

hasVisibleNamebool

True if the name is not empty and not the default one.

setEpsilon(self, epsilon)

Set the finite difference steps.

Parameters

epsilonsequence of float

If ConstantStep : Finite difference steps for each dimension.

If BlendedStep : Finite difference step factors for each dimension.

setEta(self, eta)

Set the finite difference step offsets.

Parameters

etasequence of positive float

Finite difference step offsets for each dimension.

setName(self, name)

Accessor to the object’s name.

Parameters

namestr

The name of the object.

setShadowedId(self, id)

Accessor to the object’s shadowed id.

Parameters

idint

Internal unique identifier.

setVisibility(self, visible)

Accessor to the object’s visibility state.

Parameters

visiblebool

Visibility flag.