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