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

Detailed Description

Describes the virtual functions associated with a multiple variable function.

Member Function Documentation

virtual Standard_Integer 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.

virtual Standard_Integer math_MultipleVarFunction::NbVariables ( ) const

pure virtual

Returns the number of variables of the function

Implemented in GeomInt_BSpParFunctionOfMyBSplGradientOfTheComputeLineOfWLApprox, AppDef_BSpParFunctionOfMyBSplGradientOfBSplineCompute, BRepApprox_BSpParFunctionOfMyBSplGradientOfTheComputeLineOfApprox, GeomInt_ParFunctionOfMyGradientbisOfTheComputeLineOfWLApprox, GeomInt_ParFunctionOfMyGradientOfTheComputeLineBezierOfWLApprox, AppDef_ParFunctionOfMyGradientbisOfBSplineCompute, AppDef_ParFunctionOfMyGradientOfCompute, AppDef_ParFunctionOfTheGradient, AppDef_TheFunction, BRepApprox_ParFunctionOfMyGradientbisOfTheComputeLineOfApprox, BRepApprox_ParFunctionOfMyGradientOfTheComputeLineBezierOfApprox, FairCurve_Energy, math_MultipleVarFunctionWithGradient, and math_MultipleVarFunctionWithHessian.

virtual Standard_Boolean math_MultipleVarFunction::Value ( const math_Vector &  X, Standard_Real &  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 GeomInt_BSpParFunctionOfMyBSplGradientOfTheComputeLineOfWLApprox, AppDef_BSpParFunctionOfMyBSplGradientOfBSplineCompute, BRepApprox_BSpParFunctionOfMyBSplGradientOfTheComputeLineOfApprox, GeomInt_ParFunctionOfMyGradientbisOfTheComputeLineOfWLApprox, GeomInt_ParFunctionOfMyGradientOfTheComputeLineBezierOfWLApprox, AppDef_ParFunctionOfMyGradientbisOfBSplineCompute, AppDef_ParFunctionOfMyGradientOfCompute, AppDef_ParFunctionOfTheGradient, AppDef_TheFunction, BRepApprox_ParFunctionOfMyGradientbisOfTheComputeLineOfApprox, BRepApprox_ParFunctionOfMyGradientOfTheComputeLineBezierOfApprox, FairCurve_Energy, math_MultipleVarFunctionWithGradient, and math_MultipleVarFunctionWithHessian.

---

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

• math_MultipleVarFunction.hxx