math_MultipleVarFunctionWithGradient Class Reference

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

#include <math_MultipleVarFunctionWithGradient.hxx>

Inheritance diagram for math_MultipleVarFunctionWithGradient:

Public Member Functions
virtual DEFINE_STANDARD_ALLOC void	Delete ()
virtual	~math_MultipleVarFunctionWithGradient ()
virtual Standard_Integer	NbVariables () const =0
	Returns the number of variables of the function.
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.
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.
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.

---

Constructor & Destructor Documentation

virtual math_MultipleVarFunctionWithGradient::~math_MultipleVarFunctionWithGradient

(

)

[inline, virtual]

---

Member Function Documentation

virtual DEFINE_STANDARD_ALLOC void math_MultipleVarFunctionWithGradient::Delete

(

)

[virtual]

virtual Standard_Boolean math_MultipleVarFunctionWithGradient::Gradient	(	const math_Vector &	X,
		math_Vector &	G
	)		[pure virtual]

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

virtual Standard_Integer math_MultipleVarFunctionWithGradient::NbVariables

(

)

const [pure virtual]

Implements math_MultipleVarFunction.

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

virtual Standard_Boolean math_MultipleVarFunctionWithGradient::Value	(	const math_Vector &	X,
		Standard_Real &	F
	)		[pure virtual]

Implements math_MultipleVarFunction.

Implemented in AppDef_BSpParFunctionOfMyBSplGradientOfBSplineCompute, GeomInt_BSpParFunctionOfMyBSplGradientOfTheComputeLineOfWLApprox, BRepApprox_BSpParFunctionOfMyBSplGradientOfTheComputeLineOfApprox, AppDef_TheFunction, AppDef_ParFunctionOfTheGradient, AppDef_ParFunctionOfMyGradientOfCompute, AppDef_ParFunctionOfMyGradientbisOfBSplineCompute, GeomInt_ParFunctionOfMyGradientbisOfTheComputeLineOfWLApprox, GeomInt_ParFunctionOfMyGradientOfTheComputeLineBezierOfWLApprox, 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]

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

---

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

• math_MultipleVarFunctionWithGradient.hxx