Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter Class Reference

#include <Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter.hxx>

Public Member Functions
	Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter ()
	Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter (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.
	Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter (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.
void	Initialize (const Adaptor2d_Curve2d &C, const Standard_Real Umin, const Standard_Real Usup, const Standard_Real TolU)
	sets the fields of the algorithm.
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.
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_POnCurv2d &	Point () const
	Returns the point of the extremum distance.

Constructor & Destructor Documentation

Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter() [1/3]

Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter::Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter

(

)

Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter() [2/3]

Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter::Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter	(	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.

Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter() [3/3]

Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter::Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter	(	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.

Member Function Documentation

Initialize()

void Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter::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 Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter::IsDone

(

)

const

Returns True if the distance is found.

IsMin()

Standard_Boolean Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter::IsMin

(

)

const

Returns True if the extremum distance is a minimum.

Perform()

void Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter::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 & Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter::Point

(

)

const

Returns the point of the extremum distance.

SquareDistance()

Standard_Real Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter::SquareDistance

(

)

const

Returns the value of the extremum square distance.

---

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

• Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter.hxx