Open CASCADE Technology 7.8.2.dev
Extrema_LocateExtPC2d Class Reference

#include <Extrema_LocateExtPC2d.hxx>

Public Member Functions

 Extrema_LocateExtPC2d ()
 
 Extrema_LocateExtPC2d (const gp_Pnt2d &P, const Adaptor2d_Curve2d &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 searches 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_LocateExtPC2d (const gp_Pnt2d &P, const Adaptor2d_Curve2d &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 searches 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.
 
void Initialize (const Adaptor2d_Curve2d &C, const Standard_Real Umin, const Standard_Real Usup, const Standard_Real TolF)
 sets the fields of the algorithm.
 
void Perform (const gp_Pnt2d &P, const Standard_Real U0)
 
Standard_Boolean IsDone () const
 Returns True if the distance is found.
 
Standard_Real SquareDistance () const
 Returns the value of the extremum square distance.
 
Standard_Boolean IsMin () const
 Returns True if the extremum distance is a minimum.
 
const Extrema_POnCurv2dPoint () const
 Returns the point of the extremum distance.
 

Constructor & Destructor Documentation

◆ Extrema_LocateExtPC2d() [1/3]

Extrema_LocateExtPC2d::Extrema_LocateExtPC2d ( )

◆ Extrema_LocateExtPC2d() [2/3]

Extrema_LocateExtPC2d::Extrema_LocateExtPC2d ( const gp_Pnt2d & P,
const Adaptor2d_Curve2d & 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 searches 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_LocateExtPC2d() [3/3]

Extrema_LocateExtPC2d::Extrema_LocateExtPC2d ( const gp_Pnt2d & P,
const Adaptor2d_Curve2d & 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 searches 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

◆ Initialize()

void Extrema_LocateExtPC2d::Initialize ( const Adaptor2d_Curve2d & C,
const Standard_Real Umin,
const Standard_Real Usup,
const Standard_Real TolF )

sets the fields of the algorithm.

◆ IsDone()

Standard_Boolean Extrema_LocateExtPC2d::IsDone ( ) const

Returns True if the distance is found.

◆ IsMin()

Standard_Boolean Extrema_LocateExtPC2d::IsMin ( ) const

Returns True if the extremum distance is a minimum.

◆ Perform()

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

◆ Point()

const Extrema_POnCurv2d & Extrema_LocateExtPC2d::Point ( ) const

Returns the point of the extremum distance.

◆ SquareDistance()

Standard_Real Extrema_LocateExtPC2d::SquareDistance ( ) const

Returns the value of the extremum square distance.


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