math_FunctionSetWithDerivatives Class Reference

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

#include <math_FunctionSetWithDerivatives.hxx>

Inheritance diagram for math_FunctionSetWithDerivatives:

Public Member Functions
int	NbVariables () const override=0
	Returns the number of variables of the function.
int	NbEquations () const override=0
	Returns the number of equations of the function.
bool	Value (const math_Vector &X, math_Vector &F) override=0
	Computes the values <F> of the Functions for the variable <X>. Returns True if the computation was done successfully, False otherwise.
virtual bool	Derivatives (const math_Vector &X, math_Matrix &D)=0
	Returns the values <D> of the derivatives for the variable <X>. Returns True if the computation was done successfully, False otherwise.
virtual bool	Values (const math_Vector &X, math_Vector &F, math_Matrix &D)=0
	returns the values <F> of the functions and the derivatives <D> for the variable <X>. Returns True if the computation was done successfully, False otherwise.
Public Member Functions inherited from math_FunctionSet
virtual int	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 with a set of N Functions each of M independent variables.

Member Function Documentation

Derivatives()

virtual bool math_FunctionSetWithDerivatives::Derivatives ( const math_Vector & X, math_Matrix & D )

pure virtual

Returns the values <D> of the derivatives for the variable <X>. Returns True if the computation was done successfully, False otherwise.

Implemented in Extrema_GFuncExtCC< TheCurve1, TheCurveTool1, TheCurve2, TheCurveTool2, ThePOnC, ThePoint, TheVector, TheSequenceOfPOnC >, Extrema_FuncExtCS, Extrema_FuncExtSS, Extrema_FuncPSNorm, 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, BRepBlend_CurvPointRadInv, BRepBlend_RstRstConstRad, BRepBlend_RstRstEvolRad, BRepBlend_SurfCurvConstRadInv, BRepBlend_SurfCurvEvolRadInv, BRepBlend_SurfPointConstRadInv, BRepBlend_SurfPointEvolRadInv, BRepBlend_SurfRstConstRad, BRepBlend_SurfRstEvolRad, Geom2dGcc_FunctionTanCuCuCu, Geom2dGcc_FunctionTanCuCuOnCu, Geom2dInt_TheDistBetweenPCurvesOfTheIntPCurvePCurveOfGInter, GeomFill_FunctionDraft, GeomFill_FunctionGuide, GeomInt_TheFunctionOfTheInt2SOfThePrmPrmSvSurfacesOfWLApprox, GeomInt_TheZerImpFuncOfTheImpPrmSvSurfacesOfWLApprox, IntCurveSurface_TheCSFunctionOfHInter, IntPatch_CSFunction, IntPatch_TheSurfFunction, IntWalk_TheFunctionOfTheInt2S, Contap_SurfFunction, HLRBRep_TheCSFunctionOfInterCSurf, HLRBRep_TheDistBetweenPCurvesOfTheIntPCurvePCurveOfCInter, BRepApprox_TheFunctionOfTheInt2SOfThePrmPrmSvSurfacesOfApprox, BRepApprox_TheZerImpFuncOfTheImpPrmSvSurfacesOfApprox, ProjLib_PrjFunc, Blend_AppFunction, Blend_CSFunction, Blend_CurvPointFuncInv, Blend_FuncInv, Blend_RstRstFunction, Blend_SurfCurvFuncInv, Blend_SurfPointFuncInv, Blend_SurfRstFunction, and Geom2dGcc_FunctionTanCuCu.

NbEquations()

int math_FunctionSetWithDerivatives::NbEquations ( ) const

overridepure virtual

Returns the number of equations of the function.

Implements math_FunctionSet.

Implemented in BlendFunc_ChAsym, BlendFunc_ChAsymInv, BlendFunc_ConstRad, BlendFunc_ConstRadInv, BlendFunc_CSCircular, BlendFunc_CSConstRad, BlendFunc_EvolRad, BlendFunc_EvolRadInv, BlendFunc_GenChamfer, BlendFunc_GenChamfInv, BlendFunc_Ruled, BlendFunc_RuledInv, BRepBlend_CurvPointRadInv, BRepBlend_RstRstConstRad, BRepBlend_RstRstEvolRad, BRepBlend_SurfCurvConstRadInv, BRepBlend_SurfCurvEvolRadInv, BRepBlend_SurfPointConstRadInv, BRepBlend_SurfPointEvolRadInv, BRepBlend_SurfRstConstRad, BRepBlend_SurfRstEvolRad, Geom2dGcc_FunctionTanCuCu, Geom2dGcc_FunctionTanCuCuCu, Geom2dGcc_FunctionTanCuCuOnCu, Geom2dInt_TheDistBetweenPCurvesOfTheIntPCurvePCurveOfGInter, GeomFill_FunctionDraft, GeomFill_FunctionGuide, GeomInt_TheFunctionOfTheInt2SOfThePrmPrmSvSurfacesOfWLApprox, GeomInt_TheZerImpFuncOfTheImpPrmSvSurfacesOfWLApprox, IntCurveSurface_TheCSFunctionOfHInter, IntPatch_CSFunction, IntPatch_TheSurfFunction, IntWalk_TheFunctionOfTheInt2S, Contap_SurfFunction, HLRBRep_TheCSFunctionOfInterCSurf, HLRBRep_TheDistBetweenPCurvesOfTheIntPCurvePCurveOfCInter, BRepApprox_TheFunctionOfTheInt2SOfThePrmPrmSvSurfacesOfApprox, BRepApprox_TheZerImpFuncOfTheImpPrmSvSurfacesOfApprox, Extrema_FuncExtCS, Extrema_FuncExtSS, Extrema_FuncPSNorm, Extrema_GFuncExtCC< TheCurve1, TheCurveTool1, TheCurve2, TheCurveTool2, ThePOnC, ThePoint, TheVector, TheSequenceOfPOnC >, ProjLib_PrjFunc, Blend_AppFunction, Blend_CSFunction, Blend_CurvPointFuncInv, Blend_FuncInv, Blend_RstRstFunction, Blend_SurfCurvFuncInv, Blend_SurfPointFuncInv, and Blend_SurfRstFunction.

NbVariables()

int math_FunctionSetWithDerivatives::NbVariables ( ) const

overridepure virtual

Returns the number of variables of the function.

Implements math_FunctionSet.

Implemented in Blend_CSFunction, Blend_CurvPointFuncInv, Blend_FuncInv, Blend_Function, Blend_SurfCurvFuncInv, Blend_SurfPointFuncInv, BlendFunc_CSCircular, BRepBlend_RstRstConstRad, BRepBlend_RstRstEvolRad, BRepBlend_SurfRstConstRad, BRepBlend_SurfRstEvolRad, Geom2dGcc_FunctionTanCuCu, Geom2dGcc_FunctionTanCuCuCu, Geom2dGcc_FunctionTanCuCuOnCu, Geom2dInt_TheDistBetweenPCurvesOfTheIntPCurvePCurveOfGInter, GeomFill_FunctionDraft, GeomFill_FunctionGuide, GeomInt_TheFunctionOfTheInt2SOfThePrmPrmSvSurfacesOfWLApprox, GeomInt_TheZerImpFuncOfTheImpPrmSvSurfacesOfWLApprox, IntCurveSurface_TheCSFunctionOfHInter, IntPatch_CSFunction, IntPatch_TheSurfFunction, IntWalk_TheFunctionOfTheInt2S, Contap_SurfFunction, HLRBRep_TheCSFunctionOfInterCSurf, HLRBRep_TheDistBetweenPCurvesOfTheIntPCurvePCurveOfCInter, BRepApprox_TheFunctionOfTheInt2SOfThePrmPrmSvSurfacesOfApprox, BRepApprox_TheZerImpFuncOfTheImpPrmSvSurfacesOfApprox, Extrema_FuncExtCS, Extrema_FuncExtSS, Extrema_FuncPSNorm, Extrema_GFuncExtCC< TheCurve1, TheCurveTool1, TheCurve2, TheCurveTool2, ThePOnC, ThePoint, TheVector, TheSequenceOfPOnC >, ProjLib_PrjFunc, Blend_AppFunction, Blend_RstRstFunction, and Blend_SurfRstFunction.

Value()

bool math_FunctionSetWithDerivatives::Value ( const math_Vector & X, math_Vector & F )

overridepure virtual

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

Implements math_FunctionSet.

Implemented in Extrema_GFuncExtCC< TheCurve1, TheCurveTool1, TheCurve2, TheCurveTool2, ThePOnC, ThePoint, TheVector, TheSequenceOfPOnC >, Extrema_FuncExtCS, Extrema_FuncExtSS, Extrema_FuncPSNorm, 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, BRepBlend_CurvPointRadInv, BRepBlend_RstRstConstRad, BRepBlend_RstRstEvolRad, BRepBlend_SurfCurvConstRadInv, BRepBlend_SurfCurvEvolRadInv, BRepBlend_SurfPointConstRadInv, BRepBlend_SurfPointEvolRadInv, BRepBlend_SurfRstConstRad, BRepBlend_SurfRstEvolRad, Geom2dGcc_FunctionTanCuCu, Geom2dGcc_FunctionTanCuCuCu, Geom2dGcc_FunctionTanCuCuOnCu, Geom2dInt_TheDistBetweenPCurvesOfTheIntPCurvePCurveOfGInter, GeomFill_FunctionDraft, GeomFill_FunctionGuide, GeomInt_TheFunctionOfTheInt2SOfThePrmPrmSvSurfacesOfWLApprox, GeomInt_TheZerImpFuncOfTheImpPrmSvSurfacesOfWLApprox, IntCurveSurface_TheCSFunctionOfHInter, IntPatch_CSFunction, IntPatch_TheSurfFunction, IntWalk_TheFunctionOfTheInt2S, Contap_SurfFunction, HLRBRep_TheCSFunctionOfInterCSurf, HLRBRep_TheDistBetweenPCurvesOfTheIntPCurvePCurveOfCInter, BRepApprox_TheFunctionOfTheInt2SOfThePrmPrmSvSurfacesOfApprox, BRepApprox_TheZerImpFuncOfTheImpPrmSvSurfacesOfApprox, ProjLib_PrjFunc, Blend_AppFunction, Blend_CSFunction, Blend_CurvPointFuncInv, Blend_FuncInv, Blend_RstRstFunction, Blend_SurfCurvFuncInv, Blend_SurfPointFuncInv, and Blend_SurfRstFunction.

Values()

virtual bool math_FunctionSetWithDerivatives::Values ( const math_Vector & X, math_Vector & F, math_Matrix & D )

pure virtual

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

Implemented in Extrema_GFuncExtCC< TheCurve1, TheCurveTool1, TheCurve2, TheCurveTool2, ThePOnC, ThePoint, TheVector, TheSequenceOfPOnC >, Extrema_FuncExtCS, Extrema_FuncExtSS, Extrema_FuncPSNorm, BlendFunc_ChAsym, BlendFunc_ChAsymInv, BlendFunc_ConstRad, BlendFunc_ConstRadInv, BlendFunc_CSCircular, BlendFunc_CSConstRad, BlendFunc_EvolRad, BlendFunc_EvolRadInv, BlendFunc_GenChamfer, BlendFunc_GenChamfInv, BlendFunc_Ruled, BlendFunc_RuledInv, BRepBlend_CurvPointRadInv, BRepBlend_RstRstConstRad, BRepBlend_RstRstEvolRad, BRepBlend_SurfCurvConstRadInv, BRepBlend_SurfCurvEvolRadInv, BRepBlend_SurfPointConstRadInv, BRepBlend_SurfPointEvolRadInv, BRepBlend_SurfRstConstRad, BRepBlend_SurfRstEvolRad, Geom2dGcc_FunctionTanCuCuCu, Geom2dGcc_FunctionTanCuCuOnCu, Geom2dInt_TheDistBetweenPCurvesOfTheIntPCurvePCurveOfGInter, GeomFill_FunctionDraft, GeomFill_FunctionGuide, GeomInt_TheFunctionOfTheInt2SOfThePrmPrmSvSurfacesOfWLApprox, GeomInt_TheZerImpFuncOfTheImpPrmSvSurfacesOfWLApprox, IntCurveSurface_TheCSFunctionOfHInter, IntPatch_CSFunction, IntPatch_TheSurfFunction, IntWalk_TheFunctionOfTheInt2S, Contap_SurfFunction, HLRBRep_TheCSFunctionOfInterCSurf, HLRBRep_TheDistBetweenPCurvesOfTheIntPCurvePCurveOfCInter, BRepApprox_TheFunctionOfTheInt2SOfThePrmPrmSvSurfacesOfApprox, BRepApprox_TheZerImpFuncOfTheImpPrmSvSurfacesOfApprox, ProjLib_PrjFunc, Blend_AppFunction, Blend_CSFunction, Blend_CurvPointFuncInv, Blend_FuncInv, Blend_RstRstFunction, Blend_SurfCurvFuncInv, Blend_SurfPointFuncInv, Blend_SurfRstFunction, and Geom2dGcc_FunctionTanCuCu.

---

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

• math_FunctionSetWithDerivatives.hxx