include/opencascade/GeomLib_PolyFunc.hxx

0001 // Created on: 1998-09-22
0002 // Created by: Philippe MANGINGeomLib_PolyFunc.c
0003 // Copyright (c) 1998-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 _GeomLib_PolyFunc_HeaderFile
0018 #define _GeomLib_PolyFunc_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <math_Vector.hxx>
0025 #include <math_FunctionWithDerivative.hxx>
0026
0027 //! Polynomial Function
0028 class GeomLib_PolyFunc : public math_FunctionWithDerivative
0029 {
0030 public:
0031   DEFINE_STANDARD_ALLOC
0032
0033   Standard_EXPORT GeomLib_PolyFunc(const math_Vector& Coeffs);
0034
0035   //! computes the value <F>of the function for the variable <X>.
0036   //! Returns True if the calculation were successfully done,
0037   //! False otherwise.
0038   Standard_EXPORT bool Value(const double X, double& F) override;
0039
0040   //! computes the derivative <D> of the function
0041   //! for the variable <X>.
0042   //! Returns True if the calculation were successfully done,
0043   //! False otherwise.
0044   Standard_EXPORT bool Derivative(const double X, double& D) override;
0045
0046   //! computes the value <F> and the derivative <D> of the
0047   //! function for the variable <X>.
0048   //! Returns True if the calculation were successfully done,
0049   //! False otherwise.
0050   Standard_EXPORT bool Values(const double X, double& F, double& D) override;
0051
0052 private:
0053   math_Vector myCoeffs;
0054 };
0055
0056 #endif // _GeomLib_PolyFunc_HeaderFile