math_MultipleVarFunctionWithHessian Class Reference

#include <math_MultipleVarFunctionWithHessian.hxx>

Inheritance diagram for math_MultipleVarFunctionWithHessian:

Public Member Functions
int	NbVariables () const override=0
	returns the number of variables of the function.
bool	Value (const math_Vector &X, double &F) override=0
	computes the values of the Functions <F> for the variable <X>. Returns True if the computation was done successfully, False otherwise.
bool	Gradient (const math_Vector &X, math_Vector &G) override=0
	computes the gradient <G> of the functions for the variable <X>. Returns True if the computation was done successfully, False otherwise.
bool	Values (const math_Vector &X, double &F, math_Vector &G) override=0
	computes the value <F> and the gradient <G> of the functions for the variable <X>. Returns True if the computation was done successfully, False otherwise.
virtual bool	Values (const math_Vector &X, double &F, math_Vector &G, math_Matrix &H)=0
	computes the value <F>, the gradient <G> and the hessian <H> of the functions for the variable <X>. Returns True if the computation was done successfully, False otherwise.
Public Member Functions inherited from math_MultipleVarFunction
virtual int	GetStateNumber ()
	return the state of the function corresponding to the latestt call of any methods associated to the function. This function is called by each of the algorithms described later which define the function Integer Algorithm::StateNumber(). The algorithm has the responsibility to call this function when it has found a solution (i.e. a root or a minimum) and has to maintain the association between the solution found and this StateNumber. Byu default, this method returns 0 (which means for the algorithm: no state has been saved). It is the responsibility of the programmer to decide if he needs to save the current state of the function and to return an Integer that allows retrieval of the state.
virtual	~math_MultipleVarFunction ()

Member Function Documentation

Gradient()

bool math_MultipleVarFunctionWithHessian::Gradient ( const math_Vector & X, math_Vector & G )

overridepure virtual

computes the gradient <G> of the functions for the variable <X>. Returns True if the computation was done successfully, False otherwise.

Implements math_MultipleVarFunctionWithGradient.

Implemented in Extrema_GlobOptFuncCS, FairCurve_Energy, and Extrema_GlobOptFuncCCC2.

NbVariables()

int math_MultipleVarFunctionWithHessian::NbVariables ( ) const

overridepure virtual

returns the number of variables of the function.

Implements math_MultipleVarFunctionWithGradient.

Implemented in FairCurve_Energy, Extrema_GlobOptFuncCCC2, and Extrema_GlobOptFuncCS.

Value()

bool math_MultipleVarFunctionWithHessian::Value ( const math_Vector & X, double & F )

overridepure virtual

computes the values of the Functions <F> for the variable <X>. Returns True if the computation was done successfully, False otherwise.

Implements math_MultipleVarFunctionWithGradient.

Implemented in Extrema_GlobOptFuncCS, FairCurve_Energy, and Extrema_GlobOptFuncCCC2.

Values() [1/2]

bool math_MultipleVarFunctionWithHessian::Values ( const math_Vector & X, double & F, math_Vector & G )

overridepure virtual

computes the value <F> and the gradient <G> of the functions for the variable <X>. Returns True if the computation was done successfully, False otherwise.

Implements math_MultipleVarFunctionWithGradient.

Implemented in Extrema_GlobOptFuncCS, FairCurve_Energy, and Extrema_GlobOptFuncCCC2.

Values() [2/2]

virtual bool math_MultipleVarFunctionWithHessian::Values ( const math_Vector & X, double & F, math_Vector & G, math_Matrix & H )

pure virtual

computes the value <F>, the gradient <G> and the hessian <H> of the functions for the variable <X>. Returns True if the computation was done successfully, False otherwise.

Implemented in Extrema_GlobOptFuncCS, FairCurve_Energy, and Extrema_GlobOptFuncCCC2.

---

The documentation for this class was generated from the following file:

• math_MultipleVarFunctionWithHessian.hxx