ParametricHessian

class ParametricHessian(*args)

Proxy of C++ OT::ParametricHessian

Methods

getCallsNumber()	Accessor to the number of times the hessian has been called.
getClassName()	Accessor to the object’s name.
getEvaluation()
getId()	Accessor to the object’s id.
getInputDimension()	Accessor to the number of the inputs.
getMarginal(*args)	Accessor to the hessian implementation of a specific output.
getName()	Accessor to the object’s name.
getOutputDimension()	Accessor to the number of the outputs.
getParameter()	Accessor to the parameter values.
getParameterDimension()
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.
hessian(*args)	Return the Jacobian transposed matrix of the implementation at a point.
isActualImplementation()	Accessor to the validity flag.
setName(name)	Accessor to the object’s name.
setParameter(parameter)	Accessor to the parameter values.
setShadowedId(id)	Accessor to the object’s shadowed id.
setVisibility(visible)	Accessor to the object’s visibility state.

__init__(*args)

getCallsNumber()

Accessor to the number of times the hessian has been called.

Returns:

calls_number : int

Integer that counts the number of times the hessian has been called since its creation.

getClassName()

Accessor to the object’s name.

Returns:

class_name : str

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

getId()

Accessor to the object’s id.

Returns:

id : int

Internal unique identifier.

getInputDimension()

Accessor to the number of the inputs.

Returns:

number_inputs : int

Number of inputs.

getMarginal(*args)

Accessor to the hessian implementation of a specific output.

Parameters:

i : integer

Integer corresponding to the output (Care: it starts at 0).

indices : sequence of integer

The set of indices for which the outputs are extracted.

Returns:

hessianImplementation : HessianImplementation

A hessian implementation restricted to its compenents functions which indices are i or indices.

getName()

Accessor to the object’s name.

Returns:

name : str

The name of the object.

getOutputDimension()

Accessor to the number of the outputs.

Returns:

number_outputs : int

Number of outputs.

getParameter()

Accessor to the parameter values.

Returns:

parameter : Point

The parameter values.

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.

hessian(*args)

Return the Jacobian transposed matrix of the implementation at a point.

Parameters:

point : sequence of float

Point where the Jacobian transposed matrix is calculated.

Returns:

hessian : Matrix

The Jacobian transposed matrix of the function at point.

isActualImplementation()

Accessor to the validity flag.

Returns:

is_impl : bool

Whether the implementation is valid.

setName(name)

Accessor to the object’s name.

Parameters:

name : str

The name of the object.

setParameter(parameter)

Accessor to the parameter values.

Parameters:

parameter : sequence of float

The parameter values.

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.