# Extrema_LocEPCOfLocateExtPC2d Class Reference

`#include <Extrema_LocEPCOfLocateExtPC2d.hxx>`

## Public Member Functions

Extrema_LocEPCOfLocateExtPC2d ()

Extrema_LocEPCOfLocateExtPC2d (const gp_Pnt2d &P, const Adaptor2d_Curve2d &C, const Standard_Real U0, const Standard_Real TolU)
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. More...

Extrema_LocEPCOfLocateExtPC2d (const gp_Pnt2d &P, const Adaptor2d_Curve2d &C, const Standard_Real U0, const Standard_Real Umin, const Standard_Real Usup, const Standard_Real TolU)
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 et Usup. TolU is used to decide to stop the iterations. At the nth iteration, the criteria is: abs(Un - Un-1) < TolU. More...

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

void Perform (const gp_Pnt2d &P, const Standard_Real U0)
the algorithm is done with the point P. An exception is raised if the fields have not been initialized. More...

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_POnCurv2dPoint () const
Returns the point of the extremum distance. More...

## ◆ Extrema_LocEPCOfLocateExtPC2d() [1/3]

 Extrema_LocEPCOfLocateExtPC2d::Extrema_LocEPCOfLocateExtPC2d ( )

## ◆ Extrema_LocEPCOfLocateExtPC2d() [2/3]

 Extrema_LocEPCOfLocateExtPC2d::Extrema_LocEPCOfLocateExtPC2d ( const gp_Pnt2d & P, const Adaptor2d_Curve2d & C, const Standard_Real U0, const Standard_Real TolU )

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_LocEPCOfLocateExtPC2d() [3/3]

 Extrema_LocEPCOfLocateExtPC2d::Extrema_LocEPCOfLocateExtPC2d ( const gp_Pnt2d & P, const Adaptor2d_Curve2d & C, const Standard_Real U0, const Standard_Real Umin, const Standard_Real Usup, const Standard_Real TolU )

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

## ◆ Initialize()

 void Extrema_LocEPCOfLocateExtPC2d::Initialize ( const Adaptor2d_Curve2d & C, const Standard_Real Umin, const Standard_Real Usup, const Standard_Real TolU )

sets the fields of the algorithm.

## ◆ IsDone()

 Standard_Boolean Extrema_LocEPCOfLocateExtPC2d::IsDone ( ) const

Returns True if the distance is found.

## ◆ IsMin()

 Standard_Boolean Extrema_LocEPCOfLocateExtPC2d::IsMin ( ) const

Returns True if the extremum distance is a minimum.

## ◆ Perform()

 void Extrema_LocEPCOfLocateExtPC2d::Perform ( const gp_Pnt2d & P, const Standard_Real U0 )

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

## ◆ Point()

 const Extrema_POnCurv2d& Extrema_LocEPCOfLocateExtPC2d::Point ( ) const

Returns the point of the extremum distance.

## ◆ SquareDistance()

 Standard_Real Extrema_LocEPCOfLocateExtPC2d::SquareDistance ( ) const

Returns the value of the extremum square distance.

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