annotate liboctave/ODEFunc.h @ 1536:26411f9c7603

[project @ 1995-10-05 05:41:26 by jwe]
author jwe
date Thu, 05 Oct 1995 05:51:20 +0000
parents 611d403c7f3d
children dca09b766816
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 // ODEFunc.h -*- C++ -*-
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
2 /*
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
3
1011
18933dbd5e43 [project @ 1995-01-04 04:18:15 by jwe]
jwe
parents: 882
diff changeset
4 Copyright (C) 1992, 1993, 1994, 1995 John W. Eaton
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
5
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
6 This file is part of Octave.
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
7
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
8 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
9 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
10 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
11 later version.
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
12
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
13 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
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
15 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
16 for more details.
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
17
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
18 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
19 along with Octave; see the file COPYING. If not, write to the Free
1315
611d403c7f3d [project @ 1995-06-25 19:56:32 by jwe]
jwe
parents: 1296
diff changeset
20 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
30 class ODEFunc
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
31 {
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
32 public:
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
33
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
34 typedef ColumnVector (*ODERHSFunc) (const ColumnVector&, double);
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
35 typedef Matrix (*ODEJacFunc) (const ColumnVector&, double);
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
36
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
37 ODEFunc (void)
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
38 {
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
39 fun = 0;
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
40 jac = 0;
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
41 }
532
2ca256b77602 [project @ 1994-07-20 19:56:55 by jwe]
jwe
parents: 465
diff changeset
42
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
43 ODEFunc (ODERHSFunc f)
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
44 {
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
45 fun = f;
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
46 jac = 0;
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
47 }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
48
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
49 ODEFunc (ODERHSFunc f, ODEJacFunc j)
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
50 {
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
51 fun = f;
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
52 jac = j;
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
53 }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
54
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
55 ODEFunc (const ODEFunc& a)
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
56 {
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
57 fun = a.function ();
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
58 jac = a.jacobian_function ();
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
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
61 ODEFunc& operator = (const ODEFunc& a)
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
62 {
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
63 fun = a.function ();
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
64 jac = a.jacobian_function ();
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
65
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
66 return *this;
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
67 }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
68
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
69 ODERHSFunc function (void) const { return fun; }
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
70
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
71 ODEFunc& set_function (ODERHSFunc f)
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
72 {
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
73 fun = f;
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
74 return *this;
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
75 }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
76
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
77 ODEJacFunc jacobian_function (void) const { return jac; }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
78
1536
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
79 ODEFunc& set_jacobian_function (ODEJacFunc j)
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
80 {
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
81 jac = j;
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
82 return *this;
26411f9c7603 [project @ 1995-10-05 05:41:26 by jwe]
jwe
parents: 1315
diff changeset
83 }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
84
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
85 protected:
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
86
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
87 ODERHSFunc fun;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
88
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
89 ODEJacFunc jac;
382
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 238
diff changeset
90 };
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
91
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
92 #endif
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 /*
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
95 ;;; Local Variables: ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
96 ;;; mode: C++ ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
97 ;;; page-delimiter: "^/\\*" ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
98 ;;; End: ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
99 */