GNU Octave  4.2.1
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
base-de.h
Go to the documentation of this file.
1 /*
2 
3 Copyright (C) 1996-2017 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_base_de_h)
24 #define octave_base_de_h 1
25 
26 #include "octave-config.h"
27 
28 #include <string>
29 
30 #include "dColVector.h"
31 #include "dMatrix.h"
32 
33 class
35 {
36 public:
37 
39  : x (), t (0.0), stop_time (0.0), stop_time_set (false),
40  restart (true), integration_error (false), istate (0) { }
41 
42  base_diff_eqn (const ColumnVector& xx, double tt)
43  : x (xx), t (tt), stop_time (0.0), stop_time_set (false),
44  restart (true), integration_error (false), istate (0) { }
45 
47  : x (a.x), t (a.t), stop_time (0.0), stop_time_set (false),
48  restart (true), integration_error (false), istate (0) { }
49 
50  virtual ~base_diff_eqn (void) { }
51 
52  base_diff_eqn& operator = (const base_diff_eqn& a)
53  {
54  if (this != &a)
55  {
56  x = a.x;
57  t = a.t;
58  stop_time = a.stop_time;
59  stop_time_set = a.stop_time_set;
60  restart = a.restart;
61  integration_error = a.integration_error;
62  istate = a.istate;
63  }
64 
65  return *this;
66  }
67 
68  void initialize (const ColumnVector& x0, double t0)
69  {
70  x = x0;
71  t = t0;
72  integration_error = false;
73  istate = 0;
74  force_restart ();
75  }
76 
77  octave_idx_type size (void) const { return x.numel (); }
78 
79  ColumnVector state (void) const { return x; }
80 
81  double time (void) const { return t; }
82 
83  void set_stop_time (double tt)
84  {
85  stop_time_set = true;
86  stop_time = tt;
87  force_restart ();
88  }
89 
90  void clear_stop_time (void)
91  {
92  stop_time_set = false;
93  force_restart ();
94  }
95 
96  virtual void force_restart (void) { restart = true; }
97 
98  bool integration_ok (void) const { return ! integration_error; }
99 
100  octave_idx_type integration_state (void) const { return istate; }
101 
102  virtual std::string error_message (void) const = 0;
103 
104 protected:
105 
107 
108  double t;
109 
110  double stop_time;
111 
113 
114  bool restart;
115 
117 
119 };
120 
121 #endif
double time(void) const
Definition: base-de.h:81
octave_idx_type size(void) const
Definition: base-de.h:77
ColumnVector state(void) const
Definition: base-de.h:79
bool integration_ok(void) const
Definition: base-de.h:98
void initialize(const ColumnVector &x0, double t0)
Definition: base-de.h:68
bool integration_error
Definition: base-de.h:116
octave_idx_type istate
Definition: base-de.h:118
OCTAVE_EXPORT octave_value_list return the number of command line arguments passed to Octave If called with the optional argument the function t
Definition: ov-usr-fcn.cc:935
virtual ~base_diff_eqn(void)
Definition: base-de.h:50
calling an anonymous function involves an overhead quite comparable to the overhead of an m file function Passing a handle to a built in function is because the interpreter is not involved in the internal loop For a
Definition: cellfun.cc:398
virtual void force_restart(void)
Definition: base-de.h:96
void set_stop_time(double tt)
Definition: base-de.h:83
double t
Definition: base-de.h:108
is false
Definition: cellfun.cc:398
base_diff_eqn(const ColumnVector &xx, double tt)
Definition: base-de.h:42
void clear_stop_time(void)
Definition: base-de.h:90
double stop_time
Definition: base-de.h:110
ColumnVector x
Definition: base-de.h:106
base_diff_eqn(void)
Definition: base-de.h:38
octave_idx_type integration_state(void) const
Definition: base-de.h:100
bool restart
Definition: base-de.h:114
If this string is the system will ring the terminal sometimes it is useful to be able to print the original representation of the string
Definition: utils.cc:854
base_diff_eqn(const base_diff_eqn &a)
Definition: base-de.h:46
bool stop_time_set
Definition: base-de.h:112
F77_RET_T F77_REAL &F77_RET_T F77_DBLE &F77_RET_T F77_REAL &F77_RET_T F77_DBLE &F77_RET_T F77_REAL &F77_RET_T F77_DBLE &F77_RET_T const F77_REAL const F77_REAL F77_REAL &F77_RET_T const F77_DBLE const F77_DBLE F77_DBLE &F77_RET_T F77_REAL &F77_RET_T F77_DBLE &F77_RET_T F77_DBLE &F77_RET_T F77_REAL &F77_RET_T F77_REAL &F77_RET_T F77_DBLE &F77_RET_T const F77_DBLE F77_DBLE &F77_RET_T const F77_REAL F77_REAL &F77_RET_T F77_REAL F77_REAL &F77_RET_T F77_DBLE F77_DBLE &F77_RET_T const F77_DBLE * x