ConstantStep

class ConstantStep(*args)

Constant step.

Available constructors:
ConstantStep(epsilon=[1.0])
Parameters:

epsilon : sequence of float

Finite difference steps for each dimension.

See also

BlendedStep

Notes

ConstantStep defines a list of constant finite difference steps equal to epsilon.

Examples

>>> import openturns as ot
>>> epsilon = [1e-4, 2e-4]
>>> steps = ot.ConstantStep(epsilon)
>>> print(steps([2.0]*2))
[0.0001,0.0002]
>>> print(steps([0.0, 3.0]))
[0.0001,0.0002]

Methods

__call__(inP)
getClassName() Accessor to the object’s name.
getEpsilon() Get the finite difference steps.
getId() Accessor to the object’s id.
getName() Accessor to the object’s name.
getShadowedId() Accessor to the object’s shadowed id.
getVisibility() Accessor to the object’s visibility state.
hasName() Test if the object is named.
hasVisibleName() Test if the object has a distinguishable name.
setEpsilon(epsilon) Set the finite difference steps.
setName(name) Accessor to the object’s name.
setShadowedId(id) Accessor to the object’s shadowed id.
setVisibility(visible) Accessor to the object’s visibility state.
__init__(*args)
getClassName()

Accessor to the object’s name.

Returns:

class_name : str

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

getEpsilon()

Get the finite difference steps.

Returns:

epsilon : NumericalPoint

If ConstantStep : Finite difference steps for each dimension.

If BlendedStep : Finite difference step factors for each dimension.

getId()

Accessor to the object’s id.

Returns:

id : int

Internal unique identifier.

getName()

Accessor to the object’s name.

Returns:

name : str

The name of the object.

getShadowedId()

Accessor to the object’s shadowed id.

Returns:

id : int

Internal unique identifier.

getVisibility()

Accessor to the object’s visibility state.

Returns:

visible : bool

Visibility flag.

hasName()

Test if the object is named.

Returns:

hasName : bool

True if the name is not empty.

hasVisibleName()

Test if the object has a distinguishable name.

Returns:

hasVisibleName : bool

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

setEpsilon(epsilon)

Set the finite difference steps.

Parameters:

epsilon : sequence of float

If ConstantStep : Finite difference steps for each dimension.

If BlendedStep : Finite difference step factors for each dimension.

setName(name)

Accessor to the object’s name.

Parameters:

name : str

The name of the object.

setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters:

id : int

Internal unique identifier.

setVisibility(visible)

Accessor to the object’s visibility state.

Parameters:

visible : bool

Visibility flag.