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
0028 //! Polynomial  Function
0029 class GeomLib_PolyFunc  : public math_FunctionWithDerivative
0030 {
0031 public:
0032
0033   DEFINE_STANDARD_ALLOC
0034
0035
0036   Standard_EXPORT GeomLib_PolyFunc(const math_Vector& Coeffs);
0037
0038   //! computes the value <F>of the function for the variable <X>.
0039   //! Returns True if the calculation were successfully done,
0040   //! False otherwise.
0041   Standard_EXPORT virtual Standard_Boolean Value (const Standard_Real X, Standard_Real& F) Standard_OVERRIDE;
0042
0043   //! computes the derivative <D> of the function
0044   //! for the variable <X>.
0045   //! Returns True if the calculation were successfully done,
0046   //! False otherwise.
0047   Standard_EXPORT virtual Standard_Boolean Derivative (const Standard_Real X, Standard_Real& D) Standard_OVERRIDE;
0048
0049   //! computes the value <F> and the derivative <D> of the
0050   //! function for the variable <X>.
0051   //! Returns True if the calculation were successfully done,
0052   //! False otherwise.
0053   Standard_EXPORT virtual Standard_Boolean Values (const Standard_Real X, Standard_Real& F, Standard_Real& D) Standard_OVERRIDE;
0054
0055
0056
0057
0058 protected:
0059
0060
0061
0062
0063
0064 private:
0065
0066
0067
0068   math_Vector myCoeffs;
0069
0070
0071 };
0072
0073
0074
0075
0076
0077
0078
0079 #endif // _GeomLib_PolyFunc_HeaderFile