include/opencascade/Geom2dGcc_FunctionTanObl.hxx

0001 // Created on: 1992-01-09
0002 // Created by: Remi GILET
0003 // Copyright (c) 1992-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 _Geom2dGcc_FunctionTanObl_HeaderFile
0018 #define _Geom2dGcc_FunctionTanObl_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Geom2dAdaptor_Curve.hxx>
0025 #include <gp_Dir2d.hxx>
0026 #include <math_FunctionWithDerivative.hxx>
0027
0028 //! This class describe a function of a single variable.
0029 class Geom2dGcc_FunctionTanObl : public math_FunctionWithDerivative
0030 {
0031 public:
0032   DEFINE_STANDARD_ALLOC
0033
0034   Standard_EXPORT Geom2dGcc_FunctionTanObl(const Geom2dAdaptor_Curve& Curve, const gp_Dir2d& Dir);
0035
0036   //! Computes the value of the function F for the variable X.
0037   //! It returns True if the computation is successfully done,
0038   //! False otherwise.
0039   Standard_EXPORT bool Value(const double X, double& F) override;
0040
0041   //! Computes the derivative of the function F for the variable X.
0042   //! It returns True if the computation is successfully done,
0043   //! False otherwise.
0044   Standard_EXPORT bool Derivative(const double X, double& Deriv) override;
0045
0046   //! Computes the value and the derivative of the function F
0047   //! for the variable X.
0048   //! It returns True if the computation is successfully done,
0049   //! False otherwise.
0050   Standard_EXPORT bool Values(const double X, double& F, double& Deriv) override;
0051
0052 private:
0053   Geom2dAdaptor_Curve TheCurv;
0054   gp_Dir2d            TheDirection;
0055 };
0056
0057 #endif // _Geom2dGcc_FunctionTanObl_HeaderFile