Extrema_GLocateExtPC< TheCurve, TheCurveTool, ThePoint, TheVector, ThePOnC, TheELPC, TheLocEPC > Class Template Reference

Template class for locating extremum of distance between a point and a curve. Calculates the distance with a close point. The close point is defined by the parameter value U0. The function F(u)=distance(P,C(u)) has an extremum when g(u)=dF/du=0. The algorithm searches a zero near the close point. More...

#include <Extrema_GLocateExtPC.hxx>

Public Member Functions
	Extrema_GLocateExtPC ()
	Default constructor.
	Extrema_GLocateExtPC (const ThePoint &theP, const TheCurve &theC, const double theU0, const double theTolF)
	Calculates the distance with a close point. The close point is defined by the parameter value U0. TolF is used to decide to stop the iterations. At the nth iteration, the criteria is: abs(Un - Un-1) < TolF.
	Extrema_GLocateExtPC (const ThePoint &theP, const TheCurve &theC, const double theU0, const double theUmin, const double theUsup, const double theTolF)
	Calculates the distance with a close point. The close point is defined by the parameter value U0. Zeros are searched between Umin and Usup. TolF is used to decide to stop the iterations. At the nth iteration, the criteria is: abs(Un - Un-1) < TolF.
void	Initialize (const TheCurve &theC, const double theUmin, const double theUsup, const double theTolF)
	Sets the fields of the algorithm.
void	Perform (const ThePoint &theP, const double theU0)
	Performs the algorithm with point P and initial parameter U0.
bool	IsDone () const
	Returns True if the distance is found.
double	SquareDistance () const
	Returns the value of the extremum square distance.
bool	IsMin () const
	Returns True if the extremum distance is a minimum.
const ThePOnC &	Point () const
	Returns the point of the extremum distance.

Detailed Description

template<typename TheCurve, typename TheCurveTool, typename ThePoint, typename TheVector, typename ThePOnC, typename TheELPC, typename TheLocEPC>
class Extrema_GLocateExtPC< TheCurve, TheCurveTool, ThePoint, TheVector, ThePOnC, TheELPC, TheLocEPC >

Template class for locating extremum of distance between a point and a curve. Calculates the distance with a close point. The close point is defined by the parameter value U0. The function F(u)=distance(P,C(u)) has an extremum when g(u)=dF/du=0. The algorithm searches a zero near the close point.

Template Parameters

TheCurve	Curve type (e.g., Adaptor3d_Curve, Adaptor2d_Curve2d)
TheCurveTool	Tool for curve operations
ThePoint	Point type (e.g., gp_Pnt, gp_Pnt2d)
TheVector	Vector type (e.g., gp_Vec, gp_Vec2d)
ThePOnC	Point on curve type
TheELPC	Extended local projection curve type
TheLocEPC	Local extremum point curve type

Constructor & Destructor Documentation

Extrema_GLocateExtPC() [1/3]

template<typename TheCurve , typename TheCurveTool , typename ThePoint , typename TheVector , typename ThePOnC , typename TheELPC , typename TheLocEPC >

Extrema_GLocateExtPC< TheCurve, TheCurveTool, ThePoint, TheVector, ThePOnC, TheELPC, TheLocEPC >::Extrema_GLocateExtPC ( )

inline

Default constructor.

Extrema_GLocateExtPC() [2/3]

template<typename TheCurve , typename TheCurveTool , typename ThePoint , typename TheVector , typename ThePOnC , typename TheELPC , typename TheLocEPC >

Extrema_GLocateExtPC< TheCurve, TheCurveTool, ThePoint, TheVector, ThePOnC, TheELPC, TheLocEPC >::Extrema_GLocateExtPC ( const ThePoint & theP, const TheCurve & theC, const double theU0, const double theTolF )

inline

Calculates the distance with a close point. The close point is defined by the parameter value U0. TolF is used to decide to stop the iterations. At the nth iteration, the criteria is: abs(Un - Un-1) < TolF.

Extrema_GLocateExtPC() [3/3]

template<typename TheCurve , typename TheCurveTool , typename ThePoint , typename TheVector , typename ThePOnC , typename TheELPC , typename TheLocEPC >

Extrema_GLocateExtPC< TheCurve, TheCurveTool, ThePoint, TheVector, ThePOnC, TheELPC, TheLocEPC >::Extrema_GLocateExtPC ( const ThePoint & theP, const TheCurve & theC, const double theU0, const double theUmin, const double theUsup, const double theTolF )

inline

Calculates the distance with a close point. The close point is defined by the parameter value U0. Zeros are searched between Umin and Usup. TolF is used to decide to stop the iterations. At the nth iteration, the criteria is: abs(Un - Un-1) < TolF.

Member Function Documentation

Initialize()

template<typename TheCurve , typename TheCurveTool , typename ThePoint , typename TheVector , typename ThePOnC , typename TheELPC , typename TheLocEPC >

void Extrema_GLocateExtPC< TheCurve, TheCurveTool, ThePoint, TheVector, ThePOnC, TheELPC, TheLocEPC >::Initialize ( const TheCurve & theC, const double theUmin, const double theUsup, const double theTolF )

inline

Sets the fields of the algorithm.

IsDone()

template<typename TheCurve , typename TheCurveTool , typename ThePoint , typename TheVector , typename ThePOnC , typename TheELPC , typename TheLocEPC >

bool Extrema_GLocateExtPC< TheCurve, TheCurveTool, ThePoint, TheVector, ThePOnC, TheELPC, TheLocEPC >::IsDone ( ) const

inline

Returns True if the distance is found.

IsMin()

template<typename TheCurve , typename TheCurveTool , typename ThePoint , typename TheVector , typename ThePOnC , typename TheELPC , typename TheLocEPC >

bool Extrema_GLocateExtPC< TheCurve, TheCurveTool, ThePoint, TheVector, ThePOnC, TheELPC, TheLocEPC >::IsMin ( ) const

inline

Returns True if the extremum distance is a minimum.

Perform()

template<typename TheCurve , typename TheCurveTool , typename ThePoint , typename TheVector , typename ThePOnC , typename TheELPC , typename TheLocEPC >

void Extrema_GLocateExtPC< TheCurve, TheCurveTool, ThePoint, TheVector, ThePOnC, TheELPC, TheLocEPC >::Perform ( const ThePoint & theP, const double theU0 )

inline

Performs the algorithm with point P and initial parameter U0.

Point()

template<typename TheCurve , typename TheCurveTool , typename ThePoint , typename TheVector , typename ThePOnC , typename TheELPC , typename TheLocEPC >

const ThePOnC & Extrema_GLocateExtPC< TheCurve, TheCurveTool, ThePoint, TheVector, ThePOnC, TheELPC, TheLocEPC >::Point ( ) const

inline

Returns the point of the extremum distance.

SquareDistance()

template<typename TheCurve , typename TheCurveTool , typename ThePoint , typename TheVector , typename ThePOnC , typename TheELPC , typename TheLocEPC >

double Extrema_GLocateExtPC< TheCurve, TheCurveTool, ThePoint, TheVector, ThePOnC, TheELPC, TheLocEPC >::SquareDistance ( ) const

inline

Returns the value of the extremum square distance.

---

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

• Extrema_GLocateExtPC.hxx