include/opencascade/Extrema_PCLocFOfLocEPCOfLocateExtPC2d.hxx

0001 // Created on: 1991-02-26
0002 // Created by: Isabelle GRIGNON
0003 // Copyright (c) 1991-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _Extrema_PCLocFOfLocEPCOfLocateExtPC2d_HeaderFile
0018 #define _Extrema_PCLocFOfLocEPCOfLocateExtPC2d_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <gp_Pnt2d.hxx>
0025 #include <TColStd_SequenceOfReal.hxx>
0026 #include <TColStd_SequenceOfInteger.hxx>
0027 #include <Extrema_SequenceOfPOnCurv2d.hxx>
0028 #include <Standard_Boolean.hxx>
0029 #include <math_FunctionWithDerivative.hxx>
0030 class Standard_OutOfRange;
0031 class Standard_TypeMismatch;
0032 class Adaptor2d_Curve2d;
0033 class Extrema_Curve2dTool;
0034 class Extrema_POnCurv2d;
0035 class gp_Pnt2d;
0036 class gp_Vec2d;
0037
0038 class Extrema_PCLocFOfLocEPCOfLocateExtPC2d : public math_FunctionWithDerivative
0039 {
0040 public:
0041   DEFINE_STANDARD_ALLOC
0042
0043   Standard_EXPORT Extrema_PCLocFOfLocEPCOfLocateExtPC2d();
0044
0045   Standard_EXPORT Extrema_PCLocFOfLocEPCOfLocateExtPC2d(const gp_Pnt2d&          P,
0046                                                         const Adaptor2d_Curve2d& C);
0047
0048   //! sets the field mycurve of the function.
0049   Standard_EXPORT void Initialize(const Adaptor2d_Curve2d& C);
0050
0051   //! sets the field P of the function.
0052   Standard_EXPORT void SetPoint(const gp_Pnt2d& P);
0053
0054   //! Calculation of F(U).
0055   Standard_EXPORT Standard_Boolean Value(const Standard_Real U, Standard_Real& F) Standard_OVERRIDE;
0056
0057   //! Calculation of F'(U).
0058   Standard_EXPORT Standard_Boolean Derivative(const Standard_Real U,
0059                                               Standard_Real&      DF) Standard_OVERRIDE;
0060
0061   //! Calculation of F(U) and F'(U).
0062   Standard_EXPORT Standard_Boolean Values(const Standard_Real U,
0063                                           Standard_Real&      F,
0064                                           Standard_Real&      DF) Standard_OVERRIDE;
0065
0066   //! Save the found extremum.
0067   Standard_EXPORT virtual Standard_Integer GetStateNumber() Standard_OVERRIDE;
0068
0069   //! Return the number of found extrema.
0070   Standard_EXPORT Standard_Integer NbExt() const;
0071
0072   //! Returns the Nth distance.
0073   Standard_EXPORT Standard_Real SquareDistance(const Standard_Integer N) const;
0074
0075   //! Shows if the Nth distance is a minimum.
0076   Standard_EXPORT Standard_Boolean IsMin(const Standard_Integer N) const;
0077
0078   //! Returns the Nth extremum.
0079   Standard_EXPORT const Extrema_POnCurv2d& Point(const Standard_Integer N) const;
0080
0081   //! Determines boundaries of subinterval for find of root.
0082   Standard_EXPORT void SubIntervalInitialize(const Standard_Real theUfirst,
0083                                              const Standard_Real theUlast);
0084
0085   //! Computes a Tol value. If 1st derivative of curve
0086   //! |D1|<Tol, it is considered D1=0.
0087   Standard_EXPORT Standard_Real SearchOfTolerance();
0088
0089 protected:
0090 private:
0091   gp_Pnt2d                    myP;
0092   Standard_Address            myC;
0093   Standard_Real               myU;
0094   gp_Pnt2d                    myPc;
0095   Standard_Real               myD1f;
0096   TColStd_SequenceOfReal      mySqDist;
0097   TColStd_SequenceOfInteger   myIsMin;
0098   Extrema_SequenceOfPOnCurv2d myPoint;
0099   Standard_Boolean            myPinit;
0100   Standard_Boolean            myCinit;
0101   Standard_Boolean            myD1Init;
0102   Standard_Real               myTol;
0103   Standard_Integer            myMaxDerivOrder;
0104   Standard_Real               myUinfium;
0105   Standard_Real               myUsupremum;
0106 };
0107
0108 #endif // _Extrema_PCLocFOfLocEPCOfLocateExtPC2d_HeaderFile