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