HessianImplementation

class HessianImplementation(*args)

Numerical math hessian implementation.

See also

Function, GradientImplementation

Notes

This object is the result of the method getHessian of a Function.

Methods

getCallsNumber()	Accessor to the number of times the hessian has been called.
getClassName()	Accessor to the object's name.
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.
hasName()	Test if the object is named.
hessian(inP)	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.

__init__(*args)

getCallsNumber()

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

Returns:

calls_numberint

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

getClassName()

Accessor to the object’s name.

Returns:

class_namestr

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

getInputDimension()

Accessor to the number of the inputs.

Returns:

number_inputsint

Number of inputs.

getMarginal(*args)

Accessor to the hessian implementation of a specific output.

Parameters:

iint

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

indicessequence of integer

The set of indices for which the outputs are extracted.

Returns:

hessianImplementationHessianImplementation

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

getName()

Accessor to the object’s name.

Returns:

namestr

The name of the object.

getOutputDimension()

Accessor to the number of the outputs.

Returns:

number_outputsint

Number of outputs.

getParameter()

Accessor to the parameter values.

Returns:

parameterPoint

The parameter values.

hasName()

Test if the object is named.

Returns:

hasNamebool

True if the name is not empty.

hessian(inP)

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

Parameters:

pointsequence of float

Point where the Jacobian transposed matrix is calculated.

Returns:

hessianMatrix

The Jacobian transposed matrix of the function at point.

isActualImplementation()

Accessor to the validity flag.

Returns:

is_implbool

Whether the implementation is valid.

setName(name)

Accessor to the object’s name.

Parameters:

namestr

The name of the object.

setParameter(parameter)

Accessor to the parameter values.

Parameters:

parametersequence of float

The parameter values.

Examples using the class

Estimate moments from Taylor expansions

Estimate moments from Taylor expansions

Function manipulation

Function manipulation