src/CSLib/CSLib_NormalPolyDef.hxx

   1 // Created on: 1996-08-23
   2 // Created by: Benoit TANNIOU
   3 // Copyright (c) 1996-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _CSLib_NormalPolyDef_HeaderFile
  18 #define _CSLib_NormalPolyDef_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <Standard_Integer.hxx>
  25 #include <TColStd_Array1OfReal.hxx>
  26 #include <math_FunctionWithDerivative.hxx>
  27 #include <Standard_Boolean.hxx>
  28 #include <Standard_Real.hxx>
  29
  30
  31
  32 class CSLib_NormalPolyDef  : public math_FunctionWithDerivative
  33 {
  34 public:
  35
  36   DEFINE_STANDARD_ALLOC
  37
  38
  39   Standard_EXPORT CSLib_NormalPolyDef(const Standard_Integer k0, const TColStd_Array1OfReal& li);
  40
  41   //! computes the value <F>of the function for the variable <X>.
  42   //! Returns True if the calculation were successfully done,
  43   //! False otherwise.
  44   Standard_EXPORT Standard_Boolean Value (const Standard_Real X, Standard_Real& F);
  45
  46   //! computes the derivative <D> of the function
  47   //! for the variable <X>.
  48   //! Returns True if the calculation were successfully done,
  49   //! False otherwise.
  50   Standard_EXPORT Standard_Boolean Derivative (const Standard_Real X, Standard_Real& D);
  51
  52   //! computes the value <F> and the derivative <D> of the
  53   //! function for the variable <X>.
  54   //! Returns True if the calculation were successfully done,
  55   //! False otherwise.
  56   Standard_EXPORT Standard_Boolean Values (const Standard_Real X, Standard_Real& F, Standard_Real& D);
  57
  58
  59
  60
  61 protected:
  62
  63
  64
  65
  66
  67 private:
  68
  69
  70
  71   Standard_Integer myK0;
  72   TColStd_Array1OfReal myTABli;
  73
  74
  75 };
  76
  77
  78
  79
  80
  81
  82
  83 #endif // _CSLib_NormalPolyDef_HeaderFile