1 // Created on: 1991-02-26
2 // Created by: Isabelle GRIGNON
3 // Copyright (c) 1991-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
6 // This file is part of Open CASCADE Technology software library.
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
17 #ifndef _Extrema_LocEPCOfLocateExtPC_HeaderFile
18 #define _Extrema_LocEPCOfLocateExtPC_HeaderFile
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
24 #include <Standard_Boolean.hxx>
25 #include <Standard_Real.hxx>
26 #include <Extrema_PCLocFOfLocEPCOfLocateExtPC.hxx>
27 class Standard_DomainError;
28 class Standard_TypeMismatch;
29 class StdFail_NotDone;
30 class Adaptor3d_Curve;
31 class Extrema_CurveTool;
32 class Extrema_POnCurv;
35 class Extrema_PCLocFOfLocEPCOfLocateExtPC;
37 class Extrema_LocEPCOfLocateExtPC
44 Standard_EXPORT Extrema_LocEPCOfLocateExtPC();
46 //! Calculates the distance with a close point.
47 //! The close point is defined by the parameter value
49 //! The function F(u)=distance(P,C(u)) has an extremum
50 //! when g(u)=dF/du=0. The algorithm searchs a zero
51 //! near the close point.
52 //! TolU is used to decide to stop the iterations.
53 //! At the nth iteration, the criteria is:
54 //! abs(Un - Un-1) < TolU.
55 Standard_EXPORT Extrema_LocEPCOfLocateExtPC(const gp_Pnt& P, const Adaptor3d_Curve& C, const Standard_Real U0, const Standard_Real TolU);
57 //! Calculates the distance with a close point.
58 //! The close point is defined by the parameter value
60 //! The function F(u)=distance(P,C(u)) has an extremum
61 //! when g(u)=dF/du=0. The algorithm searchs a zero
62 //! near the close point.
63 //! Zeros are searched between Umin et Usup.
64 //! TolU is used to decide to stop the iterations.
65 //! At the nth iteration, the criteria is:
66 //! abs(Un - Un-1) < TolU.
67 Standard_EXPORT Extrema_LocEPCOfLocateExtPC(const gp_Pnt& P, const Adaptor3d_Curve& C, const Standard_Real U0, const Standard_Real Umin, const Standard_Real Usup, const Standard_Real TolU);
69 //! sets the fields of the algorithm.
70 Standard_EXPORT void Initialize (const Adaptor3d_Curve& C, const Standard_Real Umin, const Standard_Real Usup, const Standard_Real TolU);
72 //! the algorithm is done with the point P.
73 //! An exception is raised if the fields have not
75 Standard_EXPORT void Perform (const gp_Pnt& P, const Standard_Real U0);
77 //! Returns True if the distance is found.
78 Standard_EXPORT Standard_Boolean IsDone() const;
80 //! Returns the value of the extremum square distance.
81 Standard_EXPORT Standard_Real SquareDistance() const;
83 //! Returns True if the extremum distance is a minimum.
84 Standard_EXPORT Standard_Boolean IsMin() const;
86 //! Returns the point of the extremum distance.
87 Standard_EXPORT const Extrema_POnCurv& Point() const;
102 Standard_Boolean myDone;
103 Standard_Real mytolU;
104 Standard_Real myumin;
105 Standard_Real myusup;
106 Extrema_PCLocFOfLocEPCOfLocateExtPC myF;
117 #endif // _Extrema_LocEPCOfLocateExtPC_HeaderFile