math_MultipleVarFunction Class Reference

Describes the virtual functions associated with a multiple variable function. More...

#include <math_MultipleVarFunction.hxx>

Inheritance diagram for math_MultipleVarFunction:

Public Member Functions
virtual int	NbVariables () const =0
	Returns the number of variables of the function.
virtual bool	Value (const math_Vector &X, double &F)=0
	Computes the values of the Functions <F> for the variable <X>. returns True if the computation was done successfully, otherwise false.
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

Describes the virtual functions associated with a multiple variable function.

Constructor & Destructor Documentation

~math_MultipleVarFunction()

virtual math_MultipleVarFunction::~math_MultipleVarFunction ( )

virtual

Member Function Documentation

GetStateNumber()

virtual int math_MultipleVarFunction::GetStateNumber ( )

virtual

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.

NbVariables()

virtual int math_MultipleVarFunction::NbVariables ( ) const

pure virtual

Returns the number of variables of the function.

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_GlobOptFuncCCC0, Extrema_GlobOptFuncCCC1, Extrema_GlobOptFuncCCC2, Extrema_GlobOptFuncConicS, Extrema_GlobOptFuncCQuadric, Extrema_GlobOptFuncCS, GCPnts_DistFunctionMV, GCPnts_DistFunction2dMV, GeomConvert_FuncConeLSDist, GeomConvert_FuncCylinderLSDist, GeomConvert_FuncSphereLSDist, math_MultipleVarFunctionWithGradient, and math_MultipleVarFunctionWithHessian.

Value()

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

pure virtual

Computes the values of the Functions <F> for the variable <X>. returns True if the computation was done successfully, otherwise false.

Implemented in Extrema_GlobOptFuncConicS, Extrema_GlobOptFuncCQuadric, 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_GlobOptFuncCCC0, Extrema_GlobOptFuncCCC1, Extrema_GlobOptFuncCCC2, GCPnts_DistFunctionMV, GCPnts_DistFunction2dMV, GeomConvert_FuncConeLSDist, GeomConvert_FuncCylinderLSDist, GeomConvert_FuncSphereLSDist, math_MultipleVarFunctionWithGradient, and math_MultipleVarFunctionWithHessian.

---

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

• math_MultipleVarFunction.hxx