CPnts_MyRootFunction Class Reference

Implements a function for the Newton algorithm to find the solution of Integral(F) = L (compute Length and Derivative of the curve for Newton). More...

#include <CPnts_MyRootFunction.hxx>

Inheritance diagram for CPnts_MyRootFunction:

Public Member Functions
	CPnts_MyRootFunction ()
void	Init (const CPnts_RealFunction &F, void *const D, const int Order)
	F is a pointer on a function D is a client data Order is the order of integration to use.
void	Init (const double X0, const double L)
	We want to solve Integral(X0,X,F(X,D)) = L.
void	Init (const double X0, const double L, const double Tol)
	We want to solve Integral(X0,X,F(X,D)) = L with given tolerance.
bool	Value (const double X, double &F) override
	This is Integral(X0,X,F(X,D)) - L.
bool	Derivative (const double X, double &Df) override
	This is F(X,D).
bool	Values (const double X, double &F, double &Df) override
	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.
Public Member Functions inherited from math_FunctionWithDerivative
	~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

Implements a function for the Newton algorithm to find the solution of Integral(F) = L (compute Length and Derivative of the curve for Newton).

Constructor & Destructor Documentation

CPnts_MyRootFunction()

CPnts_MyRootFunction::CPnts_MyRootFunction

(

)

Member Function Documentation

Derivative()

bool CPnts_MyRootFunction::Derivative ( const double X, double & Df )

overridevirtual

This is F(X,D).

Implements math_FunctionWithDerivative.

Init() [1/3]

void CPnts_MyRootFunction::Init	(	const CPnts_RealFunction &	F,
		void *const	D,
		const int	Order )

F is a pointer on a function D is a client data Order is the order of integration to use.

Init() [2/3]

void CPnts_MyRootFunction::Init	(	const double	X0,
		const double	L )

We want to solve Integral(X0,X,F(X,D)) = L.

Init() [3/3]

void CPnts_MyRootFunction::Init	(	const double	X0,
		const double	L,
		const double	Tol )

We want to solve Integral(X0,X,F(X,D)) = L with given tolerance.

Value()

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

overridevirtual

This is Integral(X0,X,F(X,D)) - L.

Implements math_FunctionWithDerivative.

Values()

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

overridevirtual

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.

Implements math_FunctionWithDerivative.

---

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

• CPnts_MyRootFunction.hxx