math_FunctionSet Class Reference

This abstract class describes the virtual functions associated to a set on N Functions of M independent variables. More...

#include <math_FunctionSet.hxx>

Inheritance diagram for math_FunctionSet:

Public Member Functions
virtual Standard_Integer	NbVariables () const =0
	Returns the number of variables of the function.
virtual Standard_Integer	NbEquations () const =0
	Returns the number of equations of the function.
virtual Standard_Boolean	Value (const math_Vector &X, math_Vector &F)=0
	Computes the values <F> of the functions for the variable <X>. returns True if the computation was done successfully, False otherwise.
virtual Standard_Integer	GetStateNumber ()
	Returns the state of the function corresponding to the latestcall of any methods associated with 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_FunctionSet ()

Detailed Description

This abstract class describes the virtual functions associated to a set on N Functions of M independent variables.

Constructor & Destructor Documentation

~math_FunctionSet()

virtual math_FunctionSet::~math_FunctionSet ( )

virtual

Member Function Documentation

GetStateNumber()

virtual Standard_Integer math_FunctionSet::GetStateNumber ( )

virtual

Returns the state of the function corresponding to the latestcall of any methods associated with 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.

Reimplemented in Extrema_CCLocFOfLocECC2d, Extrema_CCLocFOfLocECC, Extrema_FuncExtCS, Extrema_FuncExtSS, and Extrema_FuncPSNorm.

NbEquations()

virtual Standard_Integer math_FunctionSet::NbEquations ( ) const

pure virtual

Returns the number of equations of the function.

Implemented in Blend_AppFunction, Blend_CSFunction, Blend_CurvPointFuncInv, Blend_FuncInv, Blend_RstRstFunction, Blend_SurfCurvFuncInv, Blend_SurfPointFuncInv, Blend_SurfRstFunction, BlendFunc_ChAsym, BlendFunc_ChAsymInv, BlendFunc_ConstRad, BlendFunc_ConstRadInv, BlendFunc_CSCircular, BlendFunc_CSConstRad, BlendFunc_EvolRad, BlendFunc_EvolRadInv, BlendFunc_GenChamfer, BlendFunc_GenChamfInv, BlendFunc_Ruled, BlendFunc_RuledInv, BRepApprox_TheFunctionOfTheInt2SOfThePrmPrmSvSurfacesOfApprox, BRepApprox_TheZerImpFuncOfTheImpPrmSvSurfacesOfApprox, BRepBlend_CurvPointRadInv, BRepBlend_RstRstConstRad, BRepBlend_RstRstEvolRad, BRepBlend_SurfCurvConstRadInv, BRepBlend_SurfCurvEvolRadInv, BRepBlend_SurfPointConstRadInv, BRepBlend_SurfPointEvolRadInv, BRepBlend_SurfRstConstRad, BRepBlend_SurfRstEvolRad, Contap_SurfFunction, Extrema_CCLocFOfLocECC2d, Extrema_CCLocFOfLocECC, Extrema_FuncExtCS, Extrema_FuncExtSS, Extrema_FuncPSNorm, FairCurve_DistributionOfEnergy, FEmTool_ElementsOfRefMatrix, Geom2dGcc_FunctionTanCuCu, Geom2dGcc_FunctionTanCuCuCu, Geom2dGcc_FunctionTanCuCuOnCu, Geom2dInt_TheDistBetweenPCurvesOfTheIntPCurvePCurveOfGInter, GeomFill_FunctionDraft, GeomFill_FunctionGuide, GeomInt_TheFunctionOfTheInt2SOfThePrmPrmSvSurfacesOfWLApprox, GeomInt_TheZerImpFuncOfTheImpPrmSvSurfacesOfWLApprox, HLRBRep_TheCSFunctionOfInterCSurf, HLRBRep_TheDistBetweenPCurvesOfTheIntPCurvePCurveOfCInter, IntCurveSurface_TheCSFunctionOfHInter, IntPatch_CSFunction, IntPatch_TheSurfFunction, IntWalk_TheFunctionOfTheInt2S, math_FunctionSetWithDerivatives, and ProjLib_PrjFunc.

NbVariables()

virtual Standard_Integer math_FunctionSet::NbVariables ( ) const

pure virtual

Returns the number of variables of the function.

Implemented in Blend_AppFunction, Blend_CSFunction, Blend_CurvPointFuncInv, Blend_FuncInv, Blend_Function, Blend_RstRstFunction, Blend_SurfCurvFuncInv, Blend_SurfPointFuncInv, Blend_SurfRstFunction, BlendFunc_CSCircular, BRepApprox_TheFunctionOfTheInt2SOfThePrmPrmSvSurfacesOfApprox, BRepApprox_TheZerImpFuncOfTheImpPrmSvSurfacesOfApprox, BRepBlend_RstRstConstRad, BRepBlend_RstRstEvolRad, BRepBlend_SurfRstConstRad, BRepBlend_SurfRstEvolRad, Contap_SurfFunction, Extrema_CCLocFOfLocECC2d, Extrema_CCLocFOfLocECC, Extrema_FuncExtCS, Extrema_FuncExtSS, Extrema_FuncPSNorm, FairCurve_DistributionOfEnergy, FEmTool_ElementsOfRefMatrix, Geom2dGcc_FunctionTanCuCu, Geom2dGcc_FunctionTanCuCuCu, Geom2dGcc_FunctionTanCuCuOnCu, Geom2dInt_TheDistBetweenPCurvesOfTheIntPCurvePCurveOfGInter, GeomFill_FunctionDraft, GeomFill_FunctionGuide, GeomInt_TheFunctionOfTheInt2SOfThePrmPrmSvSurfacesOfWLApprox, GeomInt_TheZerImpFuncOfTheImpPrmSvSurfacesOfWLApprox, HLRBRep_TheCSFunctionOfInterCSurf, HLRBRep_TheDistBetweenPCurvesOfTheIntPCurvePCurveOfCInter, IntCurveSurface_TheCSFunctionOfHInter, IntPatch_CSFunction, IntPatch_TheSurfFunction, IntWalk_TheFunctionOfTheInt2S, math_FunctionSetWithDerivatives, and ProjLib_PrjFunc.

Value()

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

pure virtual

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

Implemented in Blend_AppFunction, Blend_CSFunction, Blend_CurvPointFuncInv, Blend_FuncInv, Blend_RstRstFunction, Blend_SurfCurvFuncInv, Blend_SurfPointFuncInv, Blend_SurfRstFunction, BlendFunc_Chamfer, BlendFunc_ChamfInv, BlendFunc_ChAsym, BlendFunc_ChAsymInv, BlendFunc_ConstRad, BlendFunc_ConstRadInv, BlendFunc_ConstThroat, BlendFunc_ConstThroatInv, BlendFunc_ConstThroatWithPenetration, BlendFunc_ConstThroatWithPenetrationInv, BlendFunc_CSCircular, BlendFunc_CSConstRad, BlendFunc_EvolRad, BlendFunc_EvolRadInv, BlendFunc_Ruled, BlendFunc_RuledInv, BRepApprox_TheFunctionOfTheInt2SOfThePrmPrmSvSurfacesOfApprox, BRepApprox_TheZerImpFuncOfTheImpPrmSvSurfacesOfApprox, BRepBlend_CurvPointRadInv, BRepBlend_RstRstConstRad, BRepBlend_RstRstEvolRad, BRepBlend_SurfCurvConstRadInv, BRepBlend_SurfCurvEvolRadInv, BRepBlend_SurfPointConstRadInv, BRepBlend_SurfPointEvolRadInv, BRepBlend_SurfRstConstRad, BRepBlend_SurfRstEvolRad, Contap_SurfFunction, Extrema_CCLocFOfLocECC2d, Extrema_CCLocFOfLocECC, Extrema_FuncExtCS, Extrema_FuncExtSS, Extrema_FuncPSNorm, FairCurve_DistributionOfJerk, FairCurve_DistributionOfSagging, FairCurve_DistributionOfTension, FEmTool_ElementsOfRefMatrix, Geom2dGcc_FunctionTanCuCu, Geom2dGcc_FunctionTanCuCuCu, Geom2dGcc_FunctionTanCuCuOnCu, Geom2dInt_TheDistBetweenPCurvesOfTheIntPCurvePCurveOfGInter, GeomFill_FunctionDraft, GeomFill_FunctionGuide, GeomInt_TheFunctionOfTheInt2SOfThePrmPrmSvSurfacesOfWLApprox, GeomInt_TheZerImpFuncOfTheImpPrmSvSurfacesOfWLApprox, HLRBRep_TheCSFunctionOfInterCSurf, HLRBRep_TheDistBetweenPCurvesOfTheIntPCurvePCurveOfCInter, IntCurveSurface_TheCSFunctionOfHInter, IntPatch_CSFunction, IntPatch_TheSurfFunction, IntWalk_TheFunctionOfTheInt2S, math_FunctionSetWithDerivatives, and ProjLib_PrjFunc.

---

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

• math_FunctionSet.hxx