include/opencascade/math_MultipleVarFunctionWithGradient.hxx

0001 // Created on: 1991-05-13
0002 // Created by: Laurent PAINNOT
0003 // Copyright (c) 1991-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_MultipleVarFunctionWithGradient_HeaderFile
0018 #define _math_MultipleVarFunctionWithGradient_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022
0023 #include <math_MultipleVarFunction.hxx>
0024 #include <Standard_Integer.hxx>
0025 #include <math_Vector.hxx>
0026
0027 //! The abstract class MultipleVarFunctionWithGradient
0028 //! describes the virtual functions associated with a multiple variable function.
0029 class math_MultipleVarFunctionWithGradient : public math_MultipleVarFunction
0030 {
0031 public:
0032   DEFINE_STANDARD_ALLOC
0033
0034   //! Returns the number of variables of the function.
0035   Standard_EXPORT int NbVariables() const override = 0;
0036
0037   //! Computes the values of the Functions <F> for the 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 variable <X>.
0043   //! Returns True if the computation was done successfully,
0044   //! False otherwise.
0045   Standard_EXPORT virtual bool Gradient(const math_Vector& X, math_Vector& G) = 0;
0046
0047   //! computes the value <F> and the gradient <G> of the
0048   //! functions for the variable <X>.
0049   //! Returns True if the computation was done successfully,
0050   //! False otherwise.
0051   Standard_EXPORT virtual bool Values(const math_Vector& X, double& F, math_Vector& G) = 0;
0052 };
0053
0054 #endif // _math_MultipleVarFunctionWithGradient_HeaderFile