annotate liboctave/ODESFunc.h @ 11523:fd0a3ac60b0e

update copyright notices
author John W. Eaton <jwe@octave.org>
date Fri, 14 Jan 2011 05:47:45 -0500
parents 81ff63e43f54
children 12df7854fa7c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3984
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
1 /*
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
2
11523
fd0a3ac60b0e update copyright notices
John W. Eaton <jwe@octave.org>
parents: 11504
diff changeset
3 Copyright (C) 2002-2011 John W. Eaton
3984
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
4
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
6
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
9 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
10 option) any later version.
3984
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
11
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
15 for more details.
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
16
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
18 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
19 <http://www.gnu.org/licenses/>.
3984
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
20
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
21 */
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
22
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
23 #if !defined (octave_ODESFunc_h)
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
24 #define octave_ODESFunc_h 1
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
25
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
26 #include "dMatrix.h"
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
27
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
28 class
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
29 ODESFunc
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
30 {
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
31 public:
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
32
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
33 struct DAEJac
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
34 {
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
35 Matrix *dfdxdot;
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
36 Matrix *dfdx;
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
37 };
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
38
4141
8c710385c572 [project @ 2002-11-01 04:20:44 by jwe]
jwe
parents: 3984
diff changeset
39 typedef ColumnVector (*ODES_fsub) (const ColumnVector& x, double,
10312
cbc402e64d83 untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents: 10158
diff changeset
40 const ColumnVector& theta);
3984
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
41
4141
8c710385c572 [project @ 2002-11-01 04:20:44 by jwe]
jwe
parents: 3984
diff changeset
42 typedef ColumnVector (*ODES_bsub) (const ColumnVector& x, double,
10312
cbc402e64d83 untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents: 10158
diff changeset
43 const ColumnVector& theta, int column);
3984
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
44
4141
8c710385c572 [project @ 2002-11-01 04:20:44 by jwe]
jwe
parents: 3984
diff changeset
45 typedef Matrix (*ODES_jsub) (const ColumnVector& x, double,
10312
cbc402e64d83 untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents: 10158
diff changeset
46 const ColumnVector& theta);
3984
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
47
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
48 ODESFunc (void)
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
49 : fsub (0), bsub (0), jsub (0) { }
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
50
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
51 ODESFunc (ODES_fsub f)
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
52 : fsub (f), bsub (0), jsub (0) { }
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
53
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
54 ODESFunc (ODES_fsub f, ODES_bsub b)
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
55 : fsub (f), bsub (b), jsub (0) { }
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
56
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
57 ODESFunc (ODES_fsub f, ODES_bsub b, ODES_jsub j)
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
58 : fsub (f), bsub (b), jsub (j) { }
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
59
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
60 ODESFunc (const ODESFunc& a)
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
61 : fsub (a.fsub), bsub (a.bsub), jsub (a.jsub) { }
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
62
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
63 ODESFunc& operator = (const ODESFunc& a)
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
64 {
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
65 if (this != &a)
10312
cbc402e64d83 untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents: 10158
diff changeset
66 {
cbc402e64d83 untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents: 10158
diff changeset
67 fsub = a.fsub;
cbc402e64d83 untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents: 10158
diff changeset
68 bsub = a.bsub;
cbc402e64d83 untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents: 10158
diff changeset
69 jsub = a.jsub;
cbc402e64d83 untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents: 10158
diff changeset
70 }
3984
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
71 return *this;
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
72 }
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
73
11504
81ff63e43f54 really make destuctors virtual in ODE/DAE base classes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
74 virtual ~ODESFunc (void) { }
3984
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
75
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
76 ODES_fsub fsub_function (void) const { return fsub; }
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
77
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
78 ODESFunc& set_fsub_function (ODES_fsub f)
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
79 {
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
80 fsub = f;
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
81 return *this;
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
82 }
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
83
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
84 ODES_bsub bsub_function (void) const { return bsub; }
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
85
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
86 ODESFunc& set_bsub_function (ODES_bsub b)
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
87 {
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
88 bsub = b;
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
89 return *this;
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
90 }
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
91
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
92 ODES_jsub jsub_function (void) const { return jsub; }
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
93
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
94 ODESFunc& set_jsub_function (ODES_jsub j)
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
95 {
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
96 jsub = j;
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
97 return *this;
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
98 }
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
99
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
100 protected:
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
101
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
102 ODES_fsub fsub;
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
103 ODES_bsub bsub;
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
104 ODES_jsub jsub;
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
105 };
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
106
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
107 #endif