This abstract class describes the virtual functions associated with a function of a single variable for which the first derivative is available. More...

#include <math_FunctionWithDerivative.hxx>

Inheritance diagram for math_FunctionWithDerivative:

[legend]

Public Member Functions
bool	Value (const double X, double &F) override=0
	Computes the value <F>of the function for the variable <X>. Returns True if the calculation were successfully done, False otherwise.

virtual bool	Derivative (const double X, double &D)=0
	Computes the derivative <D> of the function for the variable <X>. Returns True if the calculation were successfully done, False otherwise.

virtual bool	Values (const double X, double &F, double &D)=0
	Computes the value <F> and the derivative <D> of the function for the variable <X>. Returns True if the calculation were successfully done, False otherwise.

	~math_FunctionWithDerivative () override

Public Member Functions inherited from math_Function
virtual	~math_Function ()=default
	Virtual destructor, for safe inheritance.

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 for which the first derivative is available.

Constructor & Destructor Documentation

◆ ~math_FunctionWithDerivative()

math_FunctionWithDerivative::~math_FunctionWithDerivative ( )

override

Member Function Documentation

◆ Derivative()

virtual bool math_FunctionWithDerivative::Derivative	(	const double	X,
		double &	D )

pure virtual

Computes the derivative <D> of the function for the variable <X>. Returns True if the calculation were successfully done, False otherwise.

Implemented in Geom2dInt_MyImpParToolOfTheIntersectorOfTheIntConicCurveOfGInter, IntCurve_MyImpParToolOfIntImpConicParConic, IntCurveSurface_TheQuadCurvFuncOfTheQuadCurvExactHInter, HLRBRep_MyImpParToolOfTheIntersectorOfTheIntConicCurveOfCInter, HLRBRep_TheQuadCurvFuncOfTheQuadCurvExactInterCSurf, Extrema_GFuncExtPC< TheCurve, TheCurveTool, ThePOnC, ThePoint, TheVector, TheSeqPOnC >, CSLib_NormalPolyDef, math_TrigonometricEquationFunction, ChFi3d_SearchSing, GeomFill_PlanFunc, IntPatch_ArcFunction, Contap_ArcFunction, Bisector_FunctionH, Bisector_FunctionInter, Adaptor3d_InterFunc, GeomLib_PolyFunc, Geom2dGcc_FunctionTanCirCu, Geom2dGcc_FunctionTanCuPnt, Geom2dGcc_FunctionTanObl, and CPnts_MyRootFunction.

◆ Value()

bool math_FunctionWithDerivative::Value	(	const double	X,
		double &	F )

overridepure virtual

Computes the value <F>of the function for the variable <X>. Returns True if the calculation were successfully done, False otherwise.

Implements math_Function.

Implemented in Geom2dInt_MyImpParToolOfTheIntersectorOfTheIntConicCurveOfGInter, IntCurve_MyImpParToolOfIntImpConicParConic, IntCurveSurface_TheQuadCurvFuncOfTheQuadCurvExactHInter, HLRBRep_MyImpParToolOfTheIntersectorOfTheIntConicCurveOfCInter, HLRBRep_TheQuadCurvFuncOfTheQuadCurvExactInterCSurf, Extrema_GFuncExtPC< TheCurve, TheCurveTool, ThePOnC, ThePoint, TheVector, TheSeqPOnC >, CSLib_NormalPolyDef, math_TrigonometricEquationFunction, ChFi3d_SearchSing, Geom2dGcc_FunctionTanCirCu, Geom2dGcc_FunctionTanCuPnt, Geom2dGcc_FunctionTanObl, GeomFill_PlanFunc, IntPatch_ArcFunction, Contap_ArcFunction, Bisector_FunctionH, Bisector_FunctionInter, Adaptor3d_InterFunc, CPnts_MyRootFunction, and GeomLib_PolyFunc.

◆ Values()

virtual bool math_FunctionWithDerivative::Values	(	const double	X,
		double &	F,
		double &	D )