FiniteDifferenceStep

class FiniteDifferenceStep(*args)

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 ConstantStep. Another way to compute steps is through its second derived class BlendedStep.

Methods

__call__(inP)
getClassName() Accessor to the object’s name.
getEpsilon() Get the finite difference steps.
getId() Accessor to the object’s id.
getImplementation(*args) Accessor to the underlying implementation.
getName() Accessor to the object’s name.
setEpsilon(epsilon) Set the finite difference steps.
setName(name) Accessor to the object’s name.
__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.

getImplementation(*args)

Accessor to the underlying implementation.

Returns:

impl : Implementation

The implementation class.

getName()

Accessor to the object’s name.

Returns:

name : str

The name of the object.

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.