Extrema_LocateExtPC Class Reference

`#include <Extrema_LocateExtPC.hxx>`

## Public Member Functions

Extrema_LocateExtPC ()

Extrema_LocateExtPC (const gp_Pnt &P, const Adaptor3d_Curve &C, const Standard_Real U0, const Standard_Real TolF)
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 searchs a zero near the close point. TolF is used to decide to stop the iterations. At the nth iteration, the criteria is: abs(Un - Un-1) < TolF. More...

Extrema_LocateExtPC (const gp_Pnt &P, const Adaptor3d_Curve &C, const Standard_Real U0, const Standard_Real Umin, const Standard_Real Usup, const Standard_Real TolF)
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 searchs a zero near the close point. Zeros are searched between Umin et Usup. TolF is used to decide to stop the iterations. At the nth iteration, the criteria is: abs(Un - Un-1) < TolF. More...

void Initialize (const Adaptor3d_Curve &C, const Standard_Real Umin, const Standard_Real Usup, const Standard_Real TolF)
sets the fields of the algorithm. More...

void Perform (const gp_Pnt &P, const Standard_Real U0)

Standard_Boolean IsDone () const
Returns True if the distance is found. More...

Standard_Real SquareDistance () const
Returns the value of the extremum square distance. More...

Standard_Boolean IsMin () const
Returns True if the extremum distance is a minimum. More...

const Extrema_POnCurvPoint () const
Returns the point of the extremum distance. More...

## Constructor & Destructor Documentation

 Extrema_LocateExtPC::Extrema_LocateExtPC ( )
 Extrema_LocateExtPC::Extrema_LocateExtPC ( const gp_Pnt & P, const Adaptor3d_Curve & C, const Standard_Real U0, const Standard_Real TolF )

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 searchs a zero near the close point. TolF is used to decide to stop the iterations. At the nth iteration, the criteria is: abs(Un - Un-1) < TolF.

 Extrema_LocateExtPC::Extrema_LocateExtPC ( const gp_Pnt & P, const Adaptor3d_Curve & C, const Standard_Real U0, const Standard_Real Umin, const Standard_Real Usup, const Standard_Real TolF )

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 searchs a zero near the close point. Zeros are searched between Umin et 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

 void Extrema_LocateExtPC::Initialize ( const Adaptor3d_Curve & C, const Standard_Real Umin, const Standard_Real Usup, const Standard_Real TolF )

sets the fields of the algorithm.

 Standard_Boolean Extrema_LocateExtPC::IsDone ( ) const

Returns True if the distance is found.

 Standard_Boolean Extrema_LocateExtPC::IsMin ( ) const

Returns True if the extremum distance is a minimum.

 void Extrema_LocateExtPC::Perform ( const gp_Pnt & P, const Standard_Real U0 )
 const Extrema_POnCurv& Extrema_LocateExtPC::Point ( ) const

Returns the point of the extremum distance.

 Standard_Real Extrema_LocateExtPC::SquareDistance ( ) const

Returns the value of the extremum square distance.

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