b311480e |
1 | -- Created on: 1991-05-13 |
2 | -- Created by: Laurent Painnot |
3 | -- Copyright (c) 1991-1999 Matra Datavision |
973c2be1 |
4 | -- Copyright (c) 1999-2014 OPEN CASCADE SAS |
b311480e |
5 | -- |
973c2be1 |
6 | -- This file is part of Open CASCADE Technology software library. |
b311480e |
7 | -- |
d5f74e42 |
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 |
973c2be1 |
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. |
b311480e |
13 | -- |
973c2be1 |
14 | -- Alternatively, this file may be used under the terms of Open CASCADE |
15 | -- commercial license or contractual agreement. |
7fd59977 |
16 | |
17 | deferred class MultipleVarFunction from math |
18 | ---Purpose: |
19 | -- Describes the virtual functions associated with a multiple variable function. |
20 | uses Vector from math |
21 | |
22 | is |
7fd59977 |
23 | NbVariables(me) |
24 | ---Purpose: |
25 | -- Returns the number of variables of the function |
26 | |
27 | returns Integer |
28 | is deferred; |
29 | |
30 | |
31 | Value(me: in out; X: Vector; F: out Real) |
32 | ---Purpose: Computes the values of the Functions <F> for the |
33 | -- variable <X>. |
34 | -- returns True if the computation was done successfully, |
35 | -- otherwise false. |
36 | |
37 | returns Boolean |
38 | is deferred; |
39 | |
40 | |
41 | GetStateNumber(me: in out) |
42 | ---Purpose: return the state of the function corresponding to the latestt |
43 | -- call of any methods associated to the function. This |
44 | -- function is called by each of the algorithms described |
45 | -- later which define the function Integer |
46 | -- Algorithm::StateNumber(). The algorithm has the |
47 | -- responsibility to call this function when it has found |
48 | -- a solution (i.e. a root or a minimum) and has to maintain |
49 | -- the association between the solution found and this |
50 | -- StateNumber. |
51 | -- Byu default, this method returns 0 (which means for the |
52 | -- algorithm: no state has been saved). It is the |
53 | -- responsibility of the programmer to decide if he needs |
54 | -- to save the current state of the function and to return |
55 | -- an Integer that allows retrieval of the state. |
56 | |
57 | returns Integer |
58 | is virtual; |
59 | |
6da30ff1 |
60 | ---C++: alias " Standard_EXPORT virtual ~math_MultipleVarFunction();" |
61 | |
7fd59977 |
62 | end MultipleVarFunction; |