GCPnts_DistFunctionMV Class Reference

The same as class GCPnts_DistFunction, but it can be used in minimization algorithms that requires multi variable function. More...

#include <GCPnts_DistFunction.hxx>

Inheritance diagram for GCPnts_DistFunctionMV:

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

Detailed Description

The same as class GCPnts_DistFunction, but it can be used in minimization algorithms that requires multi variable function.

Constructor & Destructor Documentation

GCPnts_DistFunctionMV()

GCPnts_DistFunctionMV::GCPnts_DistFunctionMV

(

GCPnts_DistFunction &

theCurvLinDist

)

Member Function Documentation

NbVariables()

virtual Standard_Integer GCPnts_DistFunctionMV::NbVariables ( ) const

virtual

Returns the number of variables of the function.

Implements math_MultipleVarFunction.

Value()

virtual Standard_Boolean GCPnts_DistFunctionMV::Value ( const math_Vector & X, Standard_Real & F )

virtual

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

Implements math_MultipleVarFunction.

---

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

• GCPnts_DistFunction.hxx