src/math/math_MultipleVarFunctionWithGradient.hxx

   1 // Created on: 1991-05-13
   2 // Created by: Laurent PAINNOT
   3 // Copyright (c) 1991-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 _math_MultipleVarFunctionWithGradient_HeaderFile
  18 #define _math_MultipleVarFunctionWithGradient_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <math_MultipleVarFunction.hxx>
  25 #include <Standard_Integer.hxx>
  26 #include <Standard_Boolean.hxx>
  27 #include <math_Vector.hxx>
  28 #include <Standard_Real.hxx>
  29
  30
  31
  32 //! The abstract class MultipleVarFunctionWithGradient
  33 //! describes the virtual functions associated with a multiple variable function.
  34 class math_MultipleVarFunctionWithGradient  : public math_MultipleVarFunction
  35 {
  36 public:
  37
  38   DEFINE_STANDARD_ALLOC
  39
  40
  41   //! Returns the number of variables of the function.
  42   Standard_EXPORT virtual Standard_Integer NbVariables() const = 0;
  43
  44   //! Computes the values of the Functions <F> for the   variable <X>.
  45   //! Returns True if the computation was done successfully,
  46   //! False otherwise.
  47   Standard_EXPORT virtual Standard_Boolean Value (const math_Vector& X, Standard_Real& F) = 0;
  48
  49   //! Computes the gradient <G> of the functions for the   variable <X>.
  50   //! Returns True if the computation was done successfully,
  51   //! False otherwise.
  52   Standard_EXPORT virtual Standard_Boolean Gradient (const math_Vector& X, math_Vector& G) = 0;
  53
  54   //! computes the value <F> and the gradient <G> of the
  55   //! functions for the variable <X>.
  56   //! Returns True if the computation was done successfully,
  57   //! False otherwise.
  58   Standard_EXPORT virtual Standard_Boolean Values (const math_Vector& X, Standard_Real& F, math_Vector& G) = 0;
  59
  60
  61
  62
  63 protected:
  64
  65
  66
  67
  68
  69 private:
  70
  71
  72
  73
  74
  75 };
  76
  77
  78
  79
  80
  81
  82
  83 #endif // _math_MultipleVarFunctionWithGradient_HeaderFile