This abstract class describes the virtual functions associated with a Function of a single variable. More...

#include <math_Function.hxx>

Inheritance diagram for math_Function:

[legend]

Public Member Functions
virtual	~math_Function ()=default
	Virtual destructor, for safe inheritance.
virtual bool	Value (const double X, double &F)=0
	Computes the value of the function <F> for a given value of variable <X>. returns True if the computation was done successfully, False otherwise.
virtual int	GetStateNumber ()
	returns the state of the function corresponding to the latest call of any methods associated with the function. This function is called by each of the algorithms described later which defined 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.

Detailed Description

This abstract class describes the virtual functions associated with a Function of a single variable.

Constructor & Destructor Documentation

◆ ~math_Function()

virtual math_Function::~math_Function ( )

virtualdefault

Virtual destructor, for safe inheritance.

Member Function Documentation

◆ GetStateNumber()

virtual int math_Function::GetStateNumber ( )

virtual

returns the state of the function corresponding to the latest call of any methods associated with the function. This function is called by each of the algorithms described later which defined 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 BRepGProp_TFunction, Contap_ArcFunction, Extrema_GFuncExtPC< TheCurve, TheCurveTool, ThePOnC, ThePoint, TheVector, TheSeqPOnC >, Extrema_GFuncExtPC< Adaptor2d_Curve2d, Extrema_Curve2dTool, Extrema_POnCurv2d, gp_Pnt2d, gp_Vec2d, NCollection_Sequence< Extrema_POnCurv2d > >, Extrema_GFuncExtPC< Adaptor2d_Curve2d, Geom2dInt_Geom2dCurveTool, Extrema_POnCurv2d, gp_Pnt2d, gp_Vec2d, NCollection_Sequence< Extrema_POnCurv2d > >, Extrema_GFuncExtPC< Adaptor3d_Curve, Extrema_CurveTool, Extrema_POnCurv, gp_Pnt, gp_Vec, NCollection_Sequence< Extrema_POnCurv > >, Extrema_GFuncExtPC< HLRBRep_CurvePtr, HLRBRep_CurveTool, Extrema_POnCurv2d, gp_Pnt2d, gp_Vec2d, NCollection_Sequence< Extrema_POnCurv2d > >, and IntPatch_ArcFunction.

◆ Value()

virtual bool math_Function::Value	(	const double	X,
		double &	F )

pure virtual

Computes the value of the function <F> for a given value of variable <X>. returns True if the computation was done successfully, False otherwise.

Implemented in Adaptor3d_InterFunc, Bisector_FunctionH, Bisector_FunctionInter, BRepGProp_TFunction, BRepGProp_UFunction, ChFi3d_SearchSing, Contap_ArcFunction, CPnts_MyGaussFunction, CPnts_MyRootFunction, CSLib_NormalPolyDef, Extrema_GFuncExtPC< TheCurve, TheCurveTool, ThePOnC, ThePoint, TheVector, TheSeqPOnC >, Extrema_GFuncExtPC< Adaptor2d_Curve2d, Extrema_Curve2dTool, Extrema_POnCurv2d, gp_Pnt2d, gp_Vec2d, NCollection_Sequence< Extrema_POnCurv2d > >, Extrema_GFuncExtPC< Adaptor2d_Curve2d, Geom2dInt_Geom2dCurveTool, Extrema_POnCurv2d, gp_Pnt2d, gp_Vec2d, NCollection_Sequence< Extrema_POnCurv2d > >, Extrema_GFuncExtPC< Adaptor3d_Curve, Extrema_CurveTool, Extrema_POnCurv, gp_Pnt, gp_Vec, NCollection_Sequence< Extrema_POnCurv > >, Extrema_GFuncExtPC< HLRBRep_CurvePtr, HLRBRep_CurveTool, Extrema_POnCurv2d, gp_Pnt2d, gp_Vec2d, NCollection_Sequence< Extrema_POnCurv2d > >, FairCurve_BattenLaw, GCPnts_DistFunction2d, GCPnts_DistFunction, Geom2dGcc_FunctionTanCirCu, Geom2dGcc_FunctionTanCuPnt, Geom2dGcc_FunctionTanObl, Geom2dInt_MyImpParToolOfTheIntersectorOfTheIntConicCurveOfGInter, GeomFill_PlanFunc, GeomLib_PolyFunc, HLRBRep_MyImpParToolOfTheIntersectorOfTheIntConicCurveOfCInter, HLRBRep_TheQuadCurvFuncOfTheQuadCurvExactInterCSurf, IntCurve_MyImpParToolOfIntImpConicParConic, IntCurveSurface_TheQuadCurvFuncOfTheQuadCurvExactHInter, IntPatch_ArcFunction, math_FunctionWithDerivative, and math_TrigonometricEquationFunction.

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

math_Function.hxx