include/opencascade/CPnts_MyRootFunction.hxx

0001 // Created on: 1991-07-19
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 _CPnts_MyRootFunction_HeaderFile
0018 #define _CPnts_MyRootFunction_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <CPnts_MyGaussFunction.hxx>
0025 #include <Standard_Real.hxx>
0026 #include <math_FunctionWithDerivative.hxx>
0027 #include <CPnts_RealFunction.hxx>
0028
0029 //! Implements a function for the Newton algorithm to find the
0030 //! solution of Integral(F) = L
0031 //! (compute Length and Derivative of the curve for Newton)
0032 class CPnts_MyRootFunction : public math_FunctionWithDerivative
0033 {
0034 public:
0035   DEFINE_STANDARD_ALLOC
0036
0037   CPnts_MyRootFunction();
0038
0039   //! F is a pointer on a function D is a client data
0040   //! Order is the order of integration to use
0041   Standard_EXPORT void Init(const CPnts_RealFunction& F, void* const D, const int Order);
0042
0043   //! We want to solve Integral(X0,X,F(X,D)) = L
0044   Standard_EXPORT void Init(const double X0, const double L);
0045
0046   //! We want to solve Integral(X0,X,F(X,D)) = L
0047   //! with given tolerance
0048   Standard_EXPORT void Init(const double X0, const double L, const double Tol);
0049
0050   //! This is Integral(X0,X,F(X,D)) - L
0051   Standard_EXPORT bool Value(const double X, double& F) override;
0052
0053   //! This is F(X,D)
0054   Standard_EXPORT bool Derivative(const double X, double& Df) override;
0055
0056   Standard_EXPORT bool Values(const double X, double& F, double& Df) override;
0057
0058 private:
0059   CPnts_MyGaussFunction myFunction;
0060   double                myX0;
0061   double                myL;
0062   int                   myOrder;
0063   double                myTol;
0064 };
0065
0066 #include <CPnts_MyRootFunction.lxx>
0067
0068 #endif // _CPnts_MyRootFunction_HeaderFile