AppDef_TheFunction Class Reference

#include <AppDef_TheFunction.hxx>

Inheritance diagram for AppDef_TheFunction:

Public Member Functions
	AppDef_TheFunction (const AppDef_MultiLine &SSP, const Standard_Integer FirstPoint, const Standard_Integer LastPoint, const Handle< AppParCurves_HArray1OfConstraintCouple > &TheConstraints, const math_Vector &Parameters, const Standard_Integer Deg)
Standard_Integer	NbVariables () const
	Returns the number of variables of the function. More...
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, False otherwise. More...
Standard_Boolean	Gradient (const math_Vector &X, math_Vector &G)
	Computes the gradient <G> of the functions for the variable <X>. Returns True if the computation was done successfully, False otherwise. More...
Standard_Boolean	Values (const math_Vector &X, Standard_Real &F, math_Vector &G)
	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...
const math_Vector &	NewParameters () const
const AppParCurves_MultiCurve &	CurveValue ()
Standard_Real	Error (const Standard_Integer IPoint, const Standard_Integer CurveIndex) const
Standard_Real	MaxError3d () const
Standard_Real	MaxError2d () const
AppParCurves_Constraint	FirstConstraint (const Handle< AppParCurves_HArray1OfConstraintCouple > &TheConstraints, const Standard_Integer FirstPoint) const
AppParCurves_Constraint	LastConstraint (const Handle< AppParCurves_HArray1OfConstraintCouple > &TheConstraints, const Standard_Integer LastPoint) const
Public Member Functions inherited from math_MultipleVarFunctionWithGradient
virtual void	Delete ()
virtual	~math_MultipleVarFunctionWithGradient ()
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...

Protected Member Functions
void	Perform (const math_Vector &X)

Constructor & Destructor Documentation

AppDef_TheFunction::AppDef_TheFunction	(	const AppDef_MultiLine &	SSP,
		const Standard_Integer	FirstPoint,
		const Standard_Integer	LastPoint,
		const Handle< AppParCurves_HArray1OfConstraintCouple > &	TheConstraints,
		const math_Vector &	Parameters,
		const Standard_Integer	Deg
	)

Member Function Documentation

const AppParCurves_MultiCurve& AppDef_TheFunction::CurveValue

(

)

Standard_Real AppDef_TheFunction::Error	(	const Standard_Integer	IPoint,
		const Standard_Integer	CurveIndex
	)		const

AppParCurves_Constraint AppDef_TheFunction::FirstConstraint	(	const Handle< AppParCurves_HArray1OfConstraintCouple > &	TheConstraints,
		const Standard_Integer	FirstPoint
	)		const

Standard_Boolean AppDef_TheFunction::Gradient ( const math_Vector &  X, math_Vector &  G  )

virtual

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

Implements math_MultipleVarFunctionWithGradient.

AppParCurves_Constraint AppDef_TheFunction::LastConstraint	(	const Handle< AppParCurves_HArray1OfConstraintCouple > &	TheConstraints,
		const Standard_Integer	LastPoint
	)		const

Standard_Real AppDef_TheFunction::MaxError2d

(

)

const

Standard_Real AppDef_TheFunction::MaxError3d

(

)

const

Standard_Integer AppDef_TheFunction::NbVariables ( ) const

virtual

Returns the number of variables of the function.

Implements math_MultipleVarFunctionWithGradient.

const math_Vector& AppDef_TheFunction::NewParameters

(

)

const

void AppDef_TheFunction::Perform ( const math_Vector &  X )

protected

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

Implements math_MultipleVarFunctionWithGradient.

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

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.

Implements math_MultipleVarFunctionWithGradient.

---

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

• AppDef_TheFunction.hxx