include/opencascade/math_MultipleVarFunctionWithHessian.hxx

0001 // Created on: 1996-02-28
0002 // Created by: Philippe MANGIN
0003 // Copyright (c) 1996-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 _math_MultipleVarFunctionWithHessian_HeaderFile
0018 #define _math_MultipleVarFunctionWithHessian_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022
0023 #include <math_MultipleVarFunctionWithGradient.hxx>
0024 #include <Standard_Integer.hxx>
0025 #include <math_Vector.hxx>
0026 class math_Matrix;
0027
0028
0029
0030 class math_MultipleVarFunctionWithHessian  : public math_MultipleVarFunctionWithGradient
0031 {
0032 public:
0033
0034   DEFINE_STANDARD_ALLOC
0035
0036
0037   //! returns the number of variables of the function.
0038   Standard_EXPORT virtual Standard_Integer NbVariables() const = 0;
0039
0040   //! computes the values of the Functions <F> for the
0041   //! variable <X>.
0042   //! Returns True if the computation was done successfully,
0043   //! False otherwise.
0044   Standard_EXPORT virtual Standard_Boolean Value (const math_Vector& X, Standard_Real& F) = 0;
0045
0046   //! computes the gradient <G> of the functions for the
0047   //! variable <X>.
0048   //! Returns True if the computation was done successfully,
0049   //! False otherwise.
0050   Standard_EXPORT virtual Standard_Boolean Gradient (const math_Vector& X, math_Vector& G) = 0;
0051
0052   //! computes the value <F> and the gradient <G> of the
0053   //! functions for the variable <X>.
0054   //! Returns True if the computation was done successfully,
0055   //! False otherwise.
0056   Standard_EXPORT virtual Standard_Boolean Values (const math_Vector& X, Standard_Real& F, math_Vector& G) = 0;
0057
0058   //! computes the value  <F>, the gradient <G> and  the
0059   //! hessian   <H> of  the functions  for the  variable <X>.
0060   //! Returns  True  if  the computation  was  done
0061   //! successfully, False otherwise.
0062   Standard_EXPORT virtual Standard_Boolean Values (const math_Vector& X, Standard_Real& F, math_Vector& G, math_Matrix& H) = 0;
0063
0064
0065
0066
0067 protected:
0068
0069
0070
0071
0072
0073 private:
0074
0075
0076
0077
0078
0079 };
0080
0081
0082
0083
0084
0085
0086
0087 #endif // _math_MultipleVarFunctionWithHessian_HeaderFile