math_MultipleVarFunctionWithGradient Class Reference

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

#include <math_MultipleVarFunctionWithGradient.hxx>

Inheritance diagram for math_MultipleVarFunctionWithGradient:

Public Member Functions
virtual void	Delete ()
virtual	~math_MultipleVarFunctionWithGradient ()
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, False otherwise. More...
virtual Standard_Boolean	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. More...
virtual Standard_Boolean	Values (const math_Vector &X, Standard_Real &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. More...
Public Member Functions inherited from math_MultipleVarFunction
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

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

Constructor & Destructor Documentation

virtual math_MultipleVarFunctionWithGradient::~math_MultipleVarFunctionWithGradient ( )

inlinevirtual

Member Function Documentation

virtual void math_MultipleVarFunctionWithGradient::Delete ( )

virtual

virtual Standard_Boolean 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 GeomInt_BSpParFunctionOfMyBSplGradientOfTheComputeLineOfWLApprox, AppDef_BSpParFunctionOfMyBSplGradientOfBSplineCompute, BRepApprox_BSpParFunctionOfMyBSplGradientOfTheComputeLineOfApprox, GeomInt_ParFunctionOfMyGradientbisOfTheComputeLineOfWLApprox, GeomInt_ParFunctionOfMyGradientOfTheComputeLineBezierOfWLApprox, AppDef_ParFunctionOfMyGradientbisOfBSplineCompute, AppDef_ParFunctionOfMyGradientOfCompute, AppDef_ParFunctionOfTheGradient, AppDef_TheFunction, BRepApprox_ParFunctionOfMyGradientbisOfTheComputeLineOfApprox, BRepApprox_ParFunctionOfMyGradientOfTheComputeLineBezierOfApprox, FairCurve_Energy, and math_MultipleVarFunctionWithHessian.

virtual Standard_Integer math_MultipleVarFunctionWithGradient::NbVariables ( ) const

pure virtual

Returns the number of variables of the function.

Implements math_MultipleVarFunction.

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, and math_MultipleVarFunctionWithHessian.

virtual Standard_Boolean math_MultipleVarFunctionWithGradient::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,
False otherwise.

Implements math_MultipleVarFunction.

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, and math_MultipleVarFunctionWithHessian.

virtual Standard_Boolean math_MultipleVarFunctionWithGradient::Values ( const math_Vector &  X, Standard_Real &  F, math_Vector &  G  )

pure 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.

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, and math_MultipleVarFunctionWithHessian.

---

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

• math_MultipleVarFunctionWithGradient.hxx