Extrema_GenLocateExtPC< TheCurve, TheTool, ThePOnC, ThePnt, ThePCLocF > Class Template Reference

Template class for local extremum search between a point and a curve. Searches for a local extremum of distance between a point and a curve near an initial parameter value. More...

#include <Extrema_GenLocateExtPC.hxx>

Public Member Functions
	Extrema_GenLocateExtPC ()
	Default constructor.
	Extrema_GenLocateExtPC (const ThePnt &theP, const TheCurve &theC, const double theU0, const double theTolU)
	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. TolU is used to decide to stop the iterations. At the nth iteration, the criteria is: abs(Un - Un-1) < TolU.
	Extrema_GenLocateExtPC (const ThePnt &theP, const TheCurve &theC, const double theU0, const double theUmin, const double theUsup, const double theTolU)
	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. Zeros are searched between Umin and Usup. TolU is used to decide to stop the iterations. At the nth iteration, the criteria is: abs(Un - Un-1) < TolU.
void	Initialize (const TheCurve &theC, const double theUmin, const double theUsup, const double theTolU)
	Sets the fields of the algorithm.
void	Perform (const ThePnt &theP, const double theU0)
	The algorithm is done with the point P. An exception is raised if the fields have not been initialized.
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 TheTool, typename ThePOnC, typename ThePnt, typename ThePCLocF>
class Extrema_GenLocateExtPC< TheCurve, TheTool, ThePOnC, ThePnt, ThePCLocF >

Template class for local extremum search between a point and a curve. Searches for a local extremum of distance between a point and a curve near an initial parameter value.

Template Parameters

TheCurve	Curve type (e.g., Adaptor3d_Curve, Adaptor2d_Curve2d, void*)
TheTool	Tool for curve operations (e.g., Extrema_CurveTool, Extrema_Curve2dTool)
ThePOnC	Point on curve type (e.g., Extrema_POnCurv, Extrema_POnCurv2d)
ThePnt	Point type (e.g., gp_Pnt, gp_Pnt2d)
ThePCLocF	Function type for root finding

Constructor & Destructor Documentation

Extrema_GenLocateExtPC() [1/3]

template<typename TheCurve, typename TheTool, typename ThePOnC, typename ThePnt, typename ThePCLocF>

Extrema_GenLocateExtPC< TheCurve, TheTool, ThePOnC, ThePnt, ThePCLocF >::Extrema_GenLocateExtPC ( )

inline

Default constructor.

Extrema_GenLocateExtPC() [2/3]

template<typename TheCurve, typename TheTool, typename ThePOnC, typename ThePnt, typename ThePCLocF>

Extrema_GenLocateExtPC< TheCurve, TheTool, ThePOnC, ThePnt, ThePCLocF >::Extrema_GenLocateExtPC ( const ThePnt & theP, const TheCurve & theC, const double theU0, const double theTolU )

inline

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. TolU is used to decide to stop the iterations. At the nth iteration, the criteria is: abs(Un - Un-1) < TolU.

Extrema_GenLocateExtPC() [3/3]

template<typename TheCurve, typename TheTool, typename ThePOnC, typename ThePnt, typename ThePCLocF>

Extrema_GenLocateExtPC< TheCurve, TheTool, ThePOnC, ThePnt, ThePCLocF >::Extrema_GenLocateExtPC ( const ThePnt & theP, const TheCurve & theC, const double theU0, const double theUmin, const double theUsup, const double theTolU )

inline

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. Zeros are searched between Umin and Usup. TolU is used to decide to stop the iterations. At the nth iteration, the criteria is: abs(Un - Un-1) < TolU.

Member Function Documentation

Initialize()

template<typename TheCurve, typename TheTool, typename ThePOnC, typename ThePnt, typename ThePCLocF>

void Extrema_GenLocateExtPC< TheCurve, TheTool, ThePOnC, ThePnt, ThePCLocF >::Initialize ( const TheCurve & theC, const double theUmin, const double theUsup, const double theTolU )

inline

Sets the fields of the algorithm.

IsDone()

template<typename TheCurve, typename TheTool, typename ThePOnC, typename ThePnt, typename ThePCLocF>

bool Extrema_GenLocateExtPC< TheCurve, TheTool, ThePOnC, ThePnt, ThePCLocF >::IsDone ( ) const

inline

Returns True if the distance is found.

IsMin()

template<typename TheCurve, typename TheTool, typename ThePOnC, typename ThePnt, typename ThePCLocF>

bool Extrema_GenLocateExtPC< TheCurve, TheTool, ThePOnC, ThePnt, ThePCLocF >::IsMin ( ) const

inline

Returns True if the extremum distance is a minimum.

Perform()

template<typename TheCurve, typename TheTool, typename ThePOnC, typename ThePnt, typename ThePCLocF>

void Extrema_GenLocateExtPC< TheCurve, TheTool, ThePOnC, ThePnt, ThePCLocF >::Perform ( const ThePnt & theP, const double theU0 )

inline

The algorithm is done with the point P. An exception is raised if the fields have not been initialized.

Point()

template<typename TheCurve, typename TheTool, typename ThePOnC, typename ThePnt, typename ThePCLocF>

const ThePOnC & Extrema_GenLocateExtPC< TheCurve, TheTool, ThePOnC, ThePnt, ThePCLocF >::Point ( ) const

inline

Returns the point of the extremum distance.

SquareDistance()

template<typename TheCurve, typename TheTool, typename ThePOnC, typename ThePnt, typename ThePCLocF>

double Extrema_GenLocateExtPC< TheCurve, TheTool, ThePOnC, ThePnt, ThePCLocF >::SquareDistance ( ) const

inline

Returns the value of the extremum square distance.

---

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

• Extrema_GenLocateExtPC.hxx