ConstantGradient¶
- class ConstantGradient(*args)¶
Proxy of C++ OT::ConstantGradient.
Methods
Accessor to the number of times the gradient has been called.
Accessor to the object's name.
Accessor to the number of the inputs.
getMarginal
(*args)Accessor to the gradient implementation of a specific output.
getName
()Accessor to the object's name.
Accessor to the number of the outputs.
Accessor to the parameter values.
gradient
(inP)Return the Jacobian transposed matrix of the implementation at a point.
hasName
()Test if the object is named.
Accessor to the validity flag.
setName
(name)Accessor to the object's name.
setParameter
(parameter)Accessor to the parameter values.
getConstant
- __init__(*args)¶
- getCallsNumber()¶
Accessor to the number of times the gradient has been called.
- Returns:
- calls_numberint
Integer that counts the number of times the gradient 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 gradient 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:
- gradientImplementation
GradientImplementation
A gradient implementation restricted to its compenents functions which indices are i or indices.
- gradientImplementation
- 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.
- gradient(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:
- gradient
Matrix
The Jacobian transposed matrix of the function at point.
- gradient
- hasName()¶
Test if the object is named.
- Returns:
- hasNamebool
True if the name is not empty.
- 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.