Generic class for finding extremal distances between a point and a curve. More...

#include <Extrema_GGenExtPC.hxx>

Public Member Functions
	Extrema_GGenExtPC ()
	Default constructor.

	Extrema_GGenExtPC (const ThePoint &theP, const TheCurve &theC, const int theNbSample, const double theTolU, const double theTolF)
	Calculates all extremum distances between point P and curve C.

	Extrema_GGenExtPC (const ThePoint &theP, const TheCurve &theC, const int theNbSample, const double theUmin, const double theUsup, const double theTolU, const double theTolF)
	Calculates all extremum distances in a given parameter range.

void	Initialize (const TheCurve &theC, const int theNbU, const double theTolU, const double theTolF)
	Initializes the algorithm with the full curve parameter range.

void	Initialize (const TheCurve &theC, const int theNbU, const double theUmin, const double theUsup, const double theTolU, const double theTolF)
	Initializes the algorithm with a specified parameter range.

void	Initialize (const int theNbU, const double theUmin, const double theUsup, const double theTolU, const double theTolF)
	Initializes only the parameter range and tolerances.

void	Initialize (const TheCurve &theC)
	Initializes the curve for the function.

void	Perform (const ThePoint &theP)
	Performs the extremum search for the given point.

bool	IsDone () const
	Returns true if the distances are found.

int	NbExt () const
	Returns the number of extremum distances.

double	SquareDistance (const int theN) const
	Returns the Nth extremum square distance.

bool	IsMin (const int theN) const
	Returns true if the Nth extremum distance is a minimum.

const ThePOnC &	Point (const int theN) const
	Returns the point of the Nth extremum distance.

Detailed Description

template<typename TheCurve, typename TheTool, typename ThePOnC, typename ThePoint, typename ThePCF>
class Extrema_GGenExtPC< TheCurve, TheTool, ThePOnC, ThePoint, ThePCF >

Generic class for finding extremal distances between a point and a curve.

This template class searches for all parameter values u where the distance function F(u) = distance(P, C(u)) has an extremum, i.e., where dF/du = 0.

Template Parameters

TheCurve	The curve type (e.g., Adaptor3d_Curve, Adaptor2d_Curve2d)
TheTool	The curve tool providing static methods (FirstParameter, LastParameter)
ThePOnC	The point-on-curve type (e.g., Extrema_POnCurv, Extrema_POnCurv2d)
ThePoint	The point type (e.g., gp_Pnt, gp_Pnt2d)
ThePCF	The point-curve function type for extremum computation

Constructor & Destructor Documentation

◆ Extrema_GGenExtPC() [1/3]

template<typename TheCurve , typename TheTool , typename ThePOnC , typename ThePoint , typename ThePCF >

Extrema_GGenExtPC< TheCurve, TheTool, ThePOnC, ThePoint, ThePCF >::Extrema_GGenExtPC ( )

inline

Default constructor.

◆ Extrema_GGenExtPC() [2/3]

template<typename TheCurve , typename TheTool , typename ThePOnC , typename ThePoint , typename ThePCF >

Extrema_GGenExtPC< TheCurve, TheTool, ThePOnC, ThePoint, ThePCF >::Extrema_GGenExtPC	(	const ThePoint &	theP,
		const TheCurve &	theC,
		const int	theNbSample,
		const double	theTolU,
		const double	theTolF )

inline

Calculates all extremum distances between point P and curve C.

Parameters

theP	The point
theC	The curve
theNbSample	Number of sample points for root finding
theTolU	Tolerance on parameter u
theTolF	Tolerance on function value

◆ Extrema_GGenExtPC() [3/3]

template<typename TheCurve , typename TheTool , typename ThePOnC , typename ThePoint , typename ThePCF >

Extrema_GGenExtPC< TheCurve, TheTool, ThePOnC, ThePoint, ThePCF >::Extrema_GGenExtPC	(	const ThePoint &	theP,
		const TheCurve &	theC,
		const int	theNbSample,
		const double	theUmin,
		const double	theUsup,
		const double	theTolU,
		const double	theTolF )

inline

Calculates all extremum distances in a given parameter range.

Parameters

theP	The point
theC	The curve
theNbSample	Number of sample points for root finding
theUmin	Lower bound of parameter range
theUsup	Upper bound of parameter range
theTolU	Tolerance on parameter u
theTolF	Tolerance on function value

Member Function Documentation

◆ Initialize() [1/4]

template<typename TheCurve , typename TheTool , typename ThePOnC , typename ThePoint , typename ThePCF >

void Extrema_GGenExtPC< TheCurve, TheTool, ThePOnC, ThePoint, ThePCF >::Initialize	(	const int	theNbU,
		const double	theUmin,
		const double	theUsup,
		const double	theTolU,
		const double	theTolF )

inline

Initializes only the parameter range and tolerances.

Parameters

theNbU	Number of sample points
theUmin	Lower bound of parameter range
theUsup	Upper bound of parameter range
theTolU	Tolerance on parameter u
theTolF	Tolerance on function value

◆ Initialize() [2/4]

template<typename TheCurve , typename TheTool , typename ThePOnC , typename ThePoint , typename ThePCF >

void Extrema_GGenExtPC< TheCurve, TheTool, ThePOnC, ThePoint, ThePCF >::Initialize ( const TheCurve & theC )

inline

Initializes the curve for the function.

Parameters

theC The curve

◆ Initialize() [3/4]

template<typename TheCurve , typename TheTool , typename ThePOnC , typename ThePoint , typename ThePCF >

void Extrema_GGenExtPC< TheCurve, TheTool, ThePOnC, ThePoint, ThePCF >::Initialize	(	const TheCurve &	theC,
		const int	theNbU,
		const double	theTolU,
		const double	theTolF )

inline

Initializes the algorithm with the full curve parameter range.

Parameters

theC	The curve
theNbU	Number of sample points
theTolU	Tolerance on parameter u
theTolF	Tolerance on function value

◆ Initialize() [4/4]

template<typename TheCurve , typename TheTool , typename ThePOnC , typename ThePoint , typename ThePCF >

void Extrema_GGenExtPC< TheCurve, TheTool, ThePOnC, ThePoint, ThePCF >::Initialize	(	const TheCurve &	theC,
		const int	theNbU,
		const double	theUmin,
		const double	theUsup,
		const double	theTolU,
		const double	theTolF )

inline

Initializes the algorithm with a specified parameter range.

Parameters

theC	The curve
theNbU	Number of sample points
theUmin	Lower bound of parameter range
theUsup	Upper bound of parameter range
theTolU	Tolerance on parameter u
theTolF	Tolerance on function value

◆ IsDone()

template<typename TheCurve , typename TheTool , typename ThePOnC , typename ThePoint , typename ThePCF >

bool Extrema_GGenExtPC< TheCurve, TheTool, ThePOnC, ThePoint, ThePCF >::IsDone ( ) const

inline

Returns true if the distances are found.

◆ IsMin()

template<typename TheCurve , typename TheTool , typename ThePOnC , typename ThePoint , typename ThePCF >

bool Extrema_GGenExtPC< TheCurve, TheTool, ThePOnC, ThePoint, ThePCF >::IsMin ( const int theN ) const

inline

Returns true if the Nth extremum distance is a minimum.

Parameters

theN	Index of the extremum (1-based)

Returns: true if minimum, false if maximum

◆ NbExt()

template<typename TheCurve , typename TheTool , typename ThePOnC , typename ThePoint , typename ThePCF >

int Extrema_GGenExtPC< TheCurve, TheTool, ThePOnC, ThePoint, ThePCF >::NbExt ( ) const

inline

Returns the number of extremum distances.

Returns: Number of extrema found

◆ Perform()

template<typename TheCurve , typename TheTool , typename ThePOnC , typename ThePoint , typename ThePCF >

void Extrema_GGenExtPC< TheCurve, TheTool, ThePOnC, ThePoint, ThePCF >::Perform ( const ThePoint & theP )

inline

Performs the extremum search for the given point.

Parameters

theP	The point to find extrema from

◆ Point()

template<typename TheCurve , typename TheTool , typename ThePOnC , typename ThePoint , typename ThePCF >

const ThePOnC & Extrema_GGenExtPC< TheCurve, TheTool, ThePOnC, ThePoint, ThePCF >::Point ( const int theN ) const

inline

Returns the point of the Nth extremum distance.

Parameters

theN	Index of the extremum (1-based)

Returns: The point on curve

◆ SquareDistance()

template<typename TheCurve , typename TheTool , typename ThePOnC , typename ThePoint , typename ThePCF >

double Extrema_GGenExtPC< TheCurve, TheTool, ThePOnC, ThePoint, ThePCF >::SquareDistance ( const int theN ) const

inline

Returns the Nth extremum square distance.

Parameters

theN	Index of the extremum (1-based)

Returns: Square distance value

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

Extrema_GGenExtPC.hxx

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Extrema_GGenExtPC() [1/3]

◆ Extrema_GGenExtPC() [2/3]

◆ Extrema_GGenExtPC() [3/3]

Member Function Documentation

◆ Initialize() [1/4]

◆ Initialize() [2/4]

◆ Initialize() [3/4]

◆ Initialize() [4/4]

◆ IsDone()

◆ IsMin()

◆ NbExt()

◆ Perform()

◆ Point()

◆ SquareDistance()