ExtremaPC_DistanceFunction Class Reference

Distance function for point-curve extrema computation. More...

#include <ExtremaPC_DistanceFunction.hxx>

Public Member Functions
	ExtremaPC_DistanceFunction (const Adaptor3d_Curve &theCurve, const gp_Pnt &theP)
	Constructor.
bool	Value (double theU, double &theF) const
	Computes F(u) = (C(u) - P) . C'(u).
bool	Values (double theU, double &theF, double &theDF) const
	Computes F(u) and F'(u). F(u) = (C(u) - P) . C'(u) F'(u) = C'(u) . C'(u) + (C(u) - P) . C''(u)
bool	Derivative (double theU, double &theDF) const
	Computes the derivative F'(u).
double	FirstParameter () const
	Returns the first parameter of the curve.
double	LastParameter () const
	Returns the last parameter of the curve.
const gp_Pnt &	Point () const
	Returns the query point.
const Adaptor3d_Curve &	Curve () const
	Returns the curve.

Detailed Description

Distance function for point-curve extrema computation.

Implements the function F(u) = (C(u) - P) . C'(u) and its derivative F'(u) = C'(u) . C'(u) + (C(u) - P) . C''(u).

The roots of F(u) = 0 correspond to the extrema (local minima and maxima) of the squared distance function D(u) = ||C(u) - P||^2.

This class provides the interface required by MathRoot::FindAllRootsWithDerivative.

Constructor & Destructor Documentation

ExtremaPC_DistanceFunction()

ExtremaPC_DistanceFunction::ExtremaPC_DistanceFunction ( const Adaptor3d_Curve & theCurve, const gp_Pnt & theP )

inline

Constructor.

Parameters

theCurve	the curve adaptor
theP	the query point

Member Function Documentation

Curve()

const Adaptor3d_Curve & ExtremaPC_DistanceFunction::Curve ( ) const

inline

Returns the curve.

Derivative()

bool ExtremaPC_DistanceFunction::Derivative ( double theU, double & theDF ) const

inline

Computes the derivative F'(u).

Parameters

theU	parameter value
theDF	output: derivative value

Returns

true if computation succeeded

FirstParameter()

double ExtremaPC_DistanceFunction::FirstParameter ( ) const

inline

Returns the first parameter of the curve.

LastParameter()

double ExtremaPC_DistanceFunction::LastParameter ( ) const

inline

Returns the last parameter of the curve.

Point()

const gp_Pnt & ExtremaPC_DistanceFunction::Point ( ) const

inline

Returns the query point.

Value()

bool ExtremaPC_DistanceFunction::Value ( double theU, double & theF ) const

inline

Computes F(u) = (C(u) - P) . C'(u).

Parameters

theU	parameter value
theF	output: function value

Returns

true if computation succeeded

Values()

bool ExtremaPC_DistanceFunction::Values ( double theU, double & theF, double & theDF ) const

inline

Computes F(u) and F'(u). F(u) = (C(u) - P) . C'(u) F'(u) = C'(u) . C'(u) + (C(u) - P) . C''(u)

Parameters

theU	parameter value
theF	output: function value
theDF	output: derivative value

Returns

true if computation succeeded

---

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

• ExtremaPC_DistanceFunction.hxx