| 42cf5bc1 |
1 | // Created on: 1991-05-06 |
| 2 | // Created by: Laurent PAINNOT |
| 3 | // Copyright (c) 1991-1999 Matra Datavision |
| 4 | // Copyright (c) 1999-2014 OPEN CASCADE SAS |
| 5 | // |
| 6 | // This file is part of Open CASCADE Technology software library. |
| 7 | // |
| 8 | // This library is free software; you can redistribute it and/or modify it under |
| 9 | // the terms of the GNU Lesser General Public License version 2.1 as published |
| 10 | // by the Free Software Foundation, with special exception defined in the file |
| 11 | // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT |
| 12 | // distribution for complete text of the license and disclaimer of any warranty. |
| 13 | // |
| 14 | // Alternatively, this file may be used under the terms of Open CASCADE |
| 15 | // commercial license or contractual agreement. |
| 16 | |
| 17 | #ifndef _math_Function_HeaderFile |
| 18 | #define _math_Function_HeaderFile |
| 19 | |
| 20 | #include <Standard.hxx> |
| 21 | #include <Standard_DefineAlloc.hxx> |
| 22 | #include <Standard_Handle.hxx> |
| 23 | |
| 24 | #include <Standard_Boolean.hxx> |
| 25 | #include <Standard_Real.hxx> |
| 42cf5bc1 |
26 | |
| 27 | |
| 28 | //! This abstract class describes the virtual functions |
| 29 | //! associated with a Function of a single variable. |
| 30 | class math_Function |
| 31 | { |
| 32 | public: |
| 33 | |
| 34 | DEFINE_STANDARD_ALLOC |
| 35 | |
| 6928e351 |
36 | //! Virtual destructor, for safe inheritance |
| 37 | virtual ~math_Function () {} |
| 42cf5bc1 |
38 | |
| 39 | //! Computes the value of the function <F> for a given value of |
| 40 | //! variable <X>. |
| 41 | //! returns True if the computation was done successfully, |
| 42 | //! False otherwise. |
| 43 | Standard_EXPORT virtual Standard_Boolean Value (const Standard_Real X, Standard_Real& F) = 0; |
| 44 | |
| 45 | //! returns the state of the function corresponding to the |
| 46 | //! latest call of any methods associated with the function. |
| 47 | //! This function is called by each of the algorithms |
| 48 | //! described later which defined the function Integer |
| 49 | //! Algorithm::StateNumber(). The algorithm has the |
| 50 | //! responsibility to call this function when it has found |
| 51 | //! a solution (i.e. a root or a minimum) and has to maintain |
| 52 | //! the association between the solution found and this |
| 53 | //! StateNumber. |
| 54 | //! Byu default, this method returns 0 (which means for the |
| 55 | //! algorithm: no state has been saved). It is the |
| 56 | //! responsibility of the programmer to decide if he needs |
| 57 | //! to save the current state of the function and to return |
| 58 | //! an Integer that allows retrieval of the state. |
| 59 | Standard_EXPORT virtual Standard_Integer GetStateNumber(); |
| 42cf5bc1 |
60 | }; |
| 61 | |
| 42cf5bc1 |
62 | #endif // _math_Function_HeaderFile |
projects / occt.git / blame