GCPnts_DistFunction Class Reference

Class to define function, which calculates square distance between point on curve C(u), U1 <= u <= U2 and line passing through points C(U1) and C(U2) This function is used in any minimization algorithm to define maximal deviation between curve and line, which required one variable function without derivative (for ex. math_BrentMinimum). More...

#include <GCPnts_DistFunction.hxx>

Inheritance diagram for GCPnts_DistFunction:

Public Member Functions
	GCPnts_DistFunction (const Adaptor3d_Curve &theCurve, const double U1, const double U2)
	GCPnts_DistFunction (const GCPnts_DistFunction &theOther)
bool	Value (const double X, double &F) override
	Computes the value of the function <F> for a given value of variable <X>. returns True if the computation was done successfully, False otherwise.
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

Class to define function, which calculates square distance between point on curve C(u), U1 <= u <= U2 and line passing through points C(U1) and C(U2) This function is used in any minimization algorithm to define maximal deviation between curve and line, which required one variable function without derivative (for ex. math_BrentMinimum).

Constructor & Destructor Documentation

GCPnts_DistFunction() [1/2]

GCPnts_DistFunction::GCPnts_DistFunction	(	const Adaptor3d_Curve &	theCurve,
		const double	U1,
		const double	U2 )

GCPnts_DistFunction() [2/2]

GCPnts_DistFunction::GCPnts_DistFunction

(

const GCPnts_DistFunction &

theOther

)

Member Function Documentation

Value()

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

overridevirtual

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

Implements math_Function.

---

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

• GCPnts_DistFunction.hxx