The abstract class MultipleVarFunctionWithGradient describes the virtual functions associated with a multiple variable function. More...

#include <math_MultipleVarFunctionWithGradient.hxx>

Inheritance diagram for math_MultipleVarFunctionWithGradient:

[legend]

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.

virtual bool	Gradient (const math_Vector &X, math_Vector &G)=0
	Computes 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)=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.

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 ()

Detailed Description

The abstract class MultipleVarFunctionWithGradient describes the virtual functions associated with a multiple variable function.

Member Function Documentation

◆ Gradient()

virtual bool math_MultipleVarFunctionWithGradient::Gradient	(	const math_Vector &	X,
		math_Vector &	G )

pure virtual

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

Implemented in Extrema_GlobOptFuncCS, FairCurve_Energy, GeomInt_BSpParFunctionOfMyBSplGradientOfTheComputeLineOfWLApprox, GeomInt_ParFunctionOfMyGradientbisOfTheComputeLineOfWLApprox, GeomInt_ParFunctionOfMyGradientOfTheComputeLineBezierOfWLApprox, BRepApprox_BSpParFunctionOfMyBSplGradientOfTheComputeLineOfApprox, BRepApprox_ParFunctionOfMyGradientbisOfTheComputeLineOfApprox, BRepApprox_ParFunctionOfMyGradientOfTheComputeLineBezierOfApprox, AppDef_BSpParFunctionOfMyBSplGradientOfBSplineCompute, AppDef_ParFunctionOfMyGradientbisOfBSplineCompute, AppDef_ParFunctionOfMyGradientOfCompute, AppDef_ParFunctionOfTheGradient, AppDef_TheFunction, Extrema_FuncPSDist, Extrema_GlobOptFuncCCC1, Extrema_GlobOptFuncCCC2, GeomConvert_FuncCylinderLSDist, GeomConvert_FuncSphereLSDist, and math_MultipleVarFunctionWithHessian.

◆ NbVariables()

int math_MultipleVarFunctionWithGradient::NbVariables ( ) const

overridepure virtual

Returns the number of variables of the function.

Implements math_MultipleVarFunction.

Implemented in FairCurve_Energy, GeomInt_BSpParFunctionOfMyBSplGradientOfTheComputeLineOfWLApprox, GeomInt_ParFunctionOfMyGradientbisOfTheComputeLineOfWLApprox, GeomInt_ParFunctionOfMyGradientOfTheComputeLineBezierOfWLApprox, BRepApprox_BSpParFunctionOfMyBSplGradientOfTheComputeLineOfApprox, BRepApprox_ParFunctionOfMyGradientbisOfTheComputeLineOfApprox, BRepApprox_ParFunctionOfMyGradientOfTheComputeLineBezierOfApprox, AppDef_BSpParFunctionOfMyBSplGradientOfBSplineCompute, AppDef_ParFunctionOfMyGradientbisOfBSplineCompute, AppDef_ParFunctionOfMyGradientOfCompute, AppDef_ParFunctionOfTheGradient, AppDef_TheFunction, Extrema_FuncPSDist, Extrema_GlobOptFuncCCC1, Extrema_GlobOptFuncCCC2, Extrema_GlobOptFuncCS, GeomConvert_FuncCylinderLSDist, GeomConvert_FuncSphereLSDist, and math_MultipleVarFunctionWithHessian.

◆ Value()

bool math_MultipleVarFunctionWithGradient::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_MultipleVarFunction.

Implemented in Extrema_GlobOptFuncCS, FairCurve_Energy, GeomInt_BSpParFunctionOfMyBSplGradientOfTheComputeLineOfWLApprox, GeomInt_ParFunctionOfMyGradientbisOfTheComputeLineOfWLApprox, GeomInt_ParFunctionOfMyGradientOfTheComputeLineBezierOfWLApprox, BRepApprox_BSpParFunctionOfMyBSplGradientOfTheComputeLineOfApprox, BRepApprox_ParFunctionOfMyGradientbisOfTheComputeLineOfApprox, BRepApprox_ParFunctionOfMyGradientOfTheComputeLineBezierOfApprox, AppDef_BSpParFunctionOfMyBSplGradientOfBSplineCompute, AppDef_ParFunctionOfMyGradientbisOfBSplineCompute, AppDef_ParFunctionOfMyGradientOfCompute, AppDef_ParFunctionOfTheGradient, AppDef_TheFunction, Extrema_FuncPSDist, Extrema_GlobOptFuncCCC1, Extrema_GlobOptFuncCCC2, GeomConvert_FuncCylinderLSDist, GeomConvert_FuncSphereLSDist, and math_MultipleVarFunctionWithHessian.

◆ Values()

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