42cf5bc1 |
1 | // Created on: 1991-05-13 |
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_MultipleVarFunction_HeaderFile |
18 | #define _math_MultipleVarFunction_HeaderFile |
19 | |
20 | #include <Standard.hxx> |
21 | #include <Standard_DefineAlloc.hxx> |
22 | #include <Standard_Handle.hxx> |
23 | |
24 | #include <Standard_Integer.hxx> |
25 | #include <Standard_Boolean.hxx> |
26 | #include <math_Vector.hxx> |
27 | #include <Standard_Real.hxx> |
28 | |
29 | |
30 | |
31 | //! Describes the virtual functions associated with a multiple variable function. |
32 | class math_MultipleVarFunction |
33 | { |
34 | public: |
35 | |
36 | DEFINE_STANDARD_ALLOC |
37 | |
38 | |
39 | |
40 | //! Returns the number of variables of the function |
41 | Standard_EXPORT virtual Standard_Integer NbVariables() const = 0; |
42 | |
43 | //! Computes the values of the Functions <F> for the |
44 | //! variable <X>. |
45 | //! returns True if the computation was done successfully, |
46 | //! otherwise false. |
47 | Standard_EXPORT virtual Standard_Boolean Value (const math_Vector& X, Standard_Real& F) = 0; |
48 | |
49 | //! return the state of the function corresponding to the latestt |
50 | //! call of any methods associated to the function. This |
51 | //! function is called by each of the algorithms described |
52 | //! later which define the function Integer |
53 | //! Algorithm::StateNumber(). The algorithm has the |
54 | //! responsibility to call this function when it has found |
55 | //! a solution (i.e. a root or a minimum) and has to maintain |
56 | //! the association between the solution found and this |
57 | //! StateNumber. |
58 | //! Byu default, this method returns 0 (which means for the |
59 | //! algorithm: no state has been saved). It is the |
60 | //! responsibility of the programmer to decide if he needs |
61 | //! to save the current state of the function and to return |
62 | //! an Integer that allows retrieval of the state. |
63 | Standard_EXPORT virtual Standard_Integer GetStateNumber(); |
64 | Standard_EXPORT virtual ~math_MultipleVarFunction(); |
65 | |
66 | |
67 | |
68 | |
69 | protected: |
70 | |
71 | |
72 | |
73 | |
74 | |
75 | private: |
76 | |
77 | |
78 | |
79 | |
80 | |
81 | }; |
82 | |
83 | |
84 | |
85 | |
86 | |
87 | |
88 | |
89 | #endif // _math_MultipleVarFunction_HeaderFile |