src/math/math_MultipleVarFunctionWithHessian.hxx

   1 // Created on: 1996-02-28
   2 // Created by: Philippe MANGIN
   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 _math_MultipleVarFunctionWithHessian_HeaderFile
  18 #define _math_MultipleVarFunctionWithHessian_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <math_MultipleVarFunctionWithGradient.hxx>
  25 #include <Standard_Integer.hxx>
  26 #include <Standard_Boolean.hxx>
  27 #include <math_Vector.hxx>
  28 #include <Standard_Real.hxx>
  29 class math_Matrix;
  30
  31
  32
  33 class math_MultipleVarFunctionWithHessian  : public math_MultipleVarFunctionWithGradient
  34 {
  35 public:
  36
  37   DEFINE_STANDARD_ALLOC
  38
  39
  40   //! returns the number of variables of the function.
  41   Standard_EXPORT virtual Standard_Integer NbVariables() const = 0;
  42
  43   //! computes the values of the Functions <F> for the
  44   //! 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
  50   //! variable <X>.
  51   //! Returns True if the computation was done successfully,
  52   //! False otherwise.
  53   Standard_EXPORT virtual Standard_Boolean Gradient (const math_Vector& X, math_Vector& G) = 0;
  54
  55   //! computes the value <F> and the gradient <G> of the
  56   //! functions for the variable <X>.
  57   //! Returns True if the computation was done successfully,
  58   //! False otherwise.
  59   Standard_EXPORT virtual Standard_Boolean Values (const math_Vector& X, Standard_Real& F, math_Vector& G) = 0;
  60
  61   //! computes the value  <F>, the gradient <G> and  the
  62   //! hessian   <H> of  the functions  for the  variable <X>.
  63   //! Returns  True  if  the computation  was  done
  64   //! successfully, False otherwise.
  65   Standard_EXPORT virtual Standard_Boolean Values (const math_Vector& X, Standard_Real& F, math_Vector& G, math_Matrix& H) = 0;
  66
  67
  68
  69
  70 protected:
  71
  72
  73
  74
  75
  76 private:
  77
  78
  79
  80
  81
  82 };
  83
  84
  85
  86
  87
  88
  89
  90 #endif // _math_MultipleVarFunctionWithHessian_HeaderFile