annotate liboctave/ODEFunc.h @ 6469:a848b846cb3a ss-2-9-10

[project @ 2007-03-27 18:42:11 by jwe]
author jwe
date Tue, 27 Mar 2007 18:42:11 +0000
parents 4c8a2e4e0717
children 93c65f2a5668
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
1 /*
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
2
2847
8b262e771614 [project @ 1997-03-27 16:18:26 by jwe]
jwe
parents: 1993
diff changeset
3 Copyright (C) 1996, 1997 John W. Eaton
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
4
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
6
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
9 Free Software Foundation; either version 2, or (at your option) any
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
10 later version.
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
11
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
15 for more details.
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
16
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, write to the Free
5307
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 4049
diff changeset
19 Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 4049
diff changeset
20 02110-1301, USA.
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
21
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
22 */
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
23
382
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 238
diff changeset
24 #if !defined (octave_ODEFunc_h)
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 238
diff changeset
25 #define octave_ODEFunc_h 1
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 238
diff changeset
26
465
4caf8fbeb778 [project @ 1994-06-06 01:05:09 by jwe]
jwe
parents: 384
diff changeset
27 class Matrix;
4caf8fbeb778 [project @ 1994-06-06 01:05:09 by jwe]
jwe
parents: 384
diff changeset
28 class ColumnVector;
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
29
1861
620a65533630 [project @ 1996-02-04 10:17:34 by jwe]
jwe
parents: 1844
diff changeset
30 class
620a65533630 [project @ 1996-02-04 10:17:34 by jwe]
jwe
parents: 1844
diff changeset
31 ODEFunc
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
32 {
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
33 public:
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
34
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
35 typedef ColumnVector (*ODERHSFunc) (const ColumnVector&, double);
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
36 typedef Matrix (*ODEJacFunc) (const ColumnVector&, double);
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
37
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
38 ODEFunc (void)
4049
a35a3c5d4740 [project @ 2002-08-16 08:54:31 by jwe]
jwe
parents: 2847
diff changeset
39 : fun (0), jac (0), reset (true) { }
532
2ca256b77602 [project @ 1994-07-20 19:56:55 by jwe]
jwe
parents: 465
diff changeset
40
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
41 ODEFunc (ODERHSFunc f)
4049
a35a3c5d4740 [project @ 2002-08-16 08:54:31 by jwe]
jwe
parents: 2847
diff changeset
42 : fun (f), jac (0), reset (true) { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
43
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
44 ODEFunc (ODERHSFunc f, ODEJacFunc j)
4049
a35a3c5d4740 [project @ 2002-08-16 08:54:31 by jwe]
jwe
parents: 2847
diff changeset
45 : fun (f), jac (j), reset (true) { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
46
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
47 ODEFunc (const ODEFunc& a)
4049
a35a3c5d4740 [project @ 2002-08-16 08:54:31 by jwe]
jwe
parents: 2847
diff changeset
48 : fun (a.fun), jac (a.jac), reset (true) { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
49
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
50 ODEFunc& operator = (const ODEFunc& a)
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
51 {
1844
dca09b766816 [project @ 1996-02-03 11:44:20 by jwe]
jwe
parents: 1536
diff changeset
52 if (this != &a)
dca09b766816 [project @ 1996-02-03 11:44:20 by jwe]
jwe
parents: 1536
diff changeset
53 {
dca09b766816 [project @ 1996-02-03 11:44:20 by jwe]
jwe
parents: 1536
diff changeset
54 fun = a.fun;
dca09b766816 [project @ 1996-02-03 11:44:20 by jwe]
jwe
parents: 1536
diff changeset
55 jac = a.jac;
4049
a35a3c5d4740 [project @ 2002-08-16 08:54:31 by jwe]
jwe
parents: 2847
diff changeset
56 reset = a.reset;
1844
dca09b766816 [project @ 1996-02-03 11:44:20 by jwe]
jwe
parents: 1536
diff changeset
57 }
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
58 return *this;
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
59 }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
60
1861
620a65533630 [project @ 1996-02-04 10:17:34 by jwe]
jwe
parents: 1844
diff changeset
61 ~ODEFunc (void) { }
620a65533630 [project @ 1996-02-04 10:17:34 by jwe]
jwe
parents: 1844
diff changeset
62
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
63 ODERHSFunc function (void) const { return fun; }
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
64
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
65 ODEFunc& set_function (ODERHSFunc f)
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
66 {
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
67 fun = f;
4049
a35a3c5d4740 [project @ 2002-08-16 08:54:31 by jwe]
jwe
parents: 2847
diff changeset
68 reset = true;
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
69 return *this;
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
70 }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
71
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
72 ODEJacFunc jacobian_function (void) const { return jac; }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
73
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
74 ODEFunc& set_jacobian_function (ODEJacFunc j)
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
75 {
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
76 jac = j;
4049
a35a3c5d4740 [project @ 2002-08-16 08:54:31 by jwe]
jwe
parents: 2847
diff changeset
77 reset = true;
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
78 return *this;
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
79 }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
80
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
81 protected:
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
82
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
83 ODERHSFunc fun;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
84 ODEJacFunc jac;
4049
a35a3c5d4740 [project @ 2002-08-16 08:54:31 by jwe]
jwe
parents: 2847
diff changeset
85
a35a3c5d4740 [project @ 2002-08-16 08:54:31 by jwe]
jwe
parents: 2847
diff changeset
86 // This variable is TRUE when this object is constructed, and also
a35a3c5d4740 [project @ 2002-08-16 08:54:31 by jwe]
jwe
parents: 2847
diff changeset
87 // after any internal data has changed. Derived classes may use
a35a3c5d4740 [project @ 2002-08-16 08:54:31 by jwe]
jwe
parents: 2847
diff changeset
88 // this information (and change it) to know when to (re)initialize
a35a3c5d4740 [project @ 2002-08-16 08:54:31 by jwe]
jwe
parents: 2847
diff changeset
89 // their own internal data related to this object.
a35a3c5d4740 [project @ 2002-08-16 08:54:31 by jwe]
jwe
parents: 2847
diff changeset
90
a35a3c5d4740 [project @ 2002-08-16 08:54:31 by jwe]
jwe
parents: 2847
diff changeset
91 bool reset;
382
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 238
diff changeset
92 };
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
93
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
94 #endif
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
95
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
96 /*
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
97 ;;; Local Variables: ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
98 ;;; mode: C++ ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
99 ;;; End: ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
100 */