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 class math_MultipleVarFunctionWithHessian : public math_MultipleVarFunctionWithGradient
0029 {
0030 public:
0031   DEFINE_STANDARD_ALLOC
0032
0033   //! returns the number of variables of the function.
0034   Standard_EXPORT int NbVariables() const override = 0;
0035
0036   //! computes the values of the Functions <F> for the
0037   //! variable <X>.
0038   //! Returns True if the computation was done successfully,
0039   //! False otherwise.
0040   Standard_EXPORT bool Value(const math_Vector& X, double& F) override = 0;
0041
0042   //! computes the gradient <G> of the functions for the
0043   //! variable <X>.
0044   //! Returns True if the computation was done successfully,
0045   //! False otherwise.
0046   Standard_EXPORT bool Gradient(const math_Vector& X, math_Vector& G) override = 0;
0047
0048   //! computes the value <F> and the gradient <G> of the
0049   //! functions for the variable <X>.
0050   //! Returns True if the computation was done successfully,
0051   //! False otherwise.
0052   Standard_EXPORT bool Values(const math_Vector& X, double& F, math_Vector& G) override = 0;
0053
0054   //! computes the value <F>, the gradient <G> and the
0055   //! hessian <H> of the functions for the variable <X>.
0056   //! Returns True if the computation was done
0057   //! successfully, False otherwise.
0058   Standard_EXPORT virtual bool Values(const math_Vector& X,
0059                                       double&            F,
0060                                       math_Vector&       G,
0061                                       math_Matrix&       H) = 0;
0062 };
0063
0064 #endif // _math_MultipleVarFunctionWithHessian_HeaderFile