include/opencascade/math_MultipleVarFunction.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_MultipleVarFunction_HeaderFile
0018 #define _math_MultipleVarFunction_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <math_Vector.hxx>
0025
0026 //! Describes the virtual functions associated with a multiple variable function.
0027 class math_MultipleVarFunction
0028 {
0029 public:
0030   DEFINE_STANDARD_ALLOC
0031
0032   //! Returns the number of variables of the function
0033   Standard_EXPORT virtual int NbVariables() const = 0;
0034
0035   //! Computes the values of the Functions <F> for the
0036   //! variable <X>.
0037   //! returns True if the computation was done successfully,
0038   //! otherwise false.
0039   Standard_EXPORT virtual bool Value(const math_Vector& X, double& F) = 0;
0040
0041   //! return the state of the function corresponding to the latestt
0042   //! call of any methods associated to the function. This
0043   //! function is called by each of the algorithms described
0044   //! later which define the function Integer
0045   //! Algorithm::StateNumber(). The algorithm has the
0046   //! responsibility to call this function when it has found
0047   //! a solution (i.e. a root or a minimum) and has to maintain
0048   //! the association between the solution found and this
0049   //! StateNumber.
0050   //! Byu default, this method returns 0 (which means for the
0051   //! algorithm: no state has been saved). It is the
0052   //! responsibility of the programmer to decide if he needs
0053   //! to save the current state of the function and to return
0054   //! an Integer that allows retrieval of the state.
0055   Standard_EXPORT virtual int GetStateNumber();
0056   Standard_EXPORT virtual ~math_MultipleVarFunction();
0057 };
0058
0059 #endif // _math_MultipleVarFunction_HeaderFile