GNU Octave  3.8.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
ODEFunc.h
Go to the documentation of this file.
1 /*
2 
3 Copyright (C) 1993-2013 John W. Eaton
4 
5 This file is part of Octave.
6 
7 Octave is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by the
9 Free Software Foundation; either version 3 of the License, or (at your
10 option) any later version.
11 
12 Octave is distributed in the hope that it will be useful, but WITHOUT
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 for more details.
16 
17 You should have received a copy of the GNU General Public License
18 along with Octave; see the file COPYING. If not, see
19 <http://www.gnu.org/licenses/>.
20 
21 */
22 
23 #if !defined (octave_ODEFunc_h)
24 #define octave_ODEFunc_h 1
25 
26 class Matrix;
27 class ColumnVector;
28 
29 class
30 ODEFunc
31 {
32 public:
33 
34  typedef ColumnVector (*ODERHSFunc) (const ColumnVector&, double);
35  typedef Matrix (*ODEJacFunc) (const ColumnVector&, double);
36 
37  ODEFunc (void)
38  : fun (0), jac (0), reset (true) { }
39 
40  ODEFunc (ODERHSFunc f)
41  : fun (f), jac (0), reset (true) { }
42 
43  ODEFunc (ODERHSFunc f, ODEJacFunc j)
44  : fun (f), jac (j), reset (true) { }
45 
46  ODEFunc (const ODEFunc& a)
47  : fun (a.fun), jac (a.jac), reset (true) { }
48 
50  {
51  if (this != &a)
52  {
53  fun = a.fun;
54  jac = a.jac;
55  reset = a.reset;
56  }
57  return *this;
58  }
59 
60  virtual ~ODEFunc (void) { }
61 
62  ODERHSFunc function (void) const { return fun; }
63 
64  ODEFunc& set_function (ODERHSFunc f)
65  {
66  fun = f;
67  reset = true;
68  return *this;
69  }
70 
71  ODEJacFunc jacobian_function (void) const { return jac; }
72 
73  ODEFunc& set_jacobian_function (ODEJacFunc j)
74  {
75  jac = j;
76  reset = true;
77  return *this;
78  }
79 
80 protected:
81 
82  ODERHSFunc fun;
83  ODEJacFunc jac;
84 
85  // This variable is TRUE when this object is constructed, and also
86  // after any internal data has changed. Derived classes may use
87  // this information (and change it) to know when to (re)initialize
88  // their own internal data related to this object.
89 
90  bool reset;
91 };
92 
93 #endif