annotate liboctave/numeric/ODES.h @ 17769:49a5a4be04a1

maint: Use GNU style coding conventions for code in liboctave/ * liboctave/array/Array-C.cc, liboctave/array/Array-b.cc, liboctave/array/Array-ch.cc, liboctave/array/Array-d.cc, liboctave/array/Array-f.cc, liboctave/array/Array-fC.cc, liboctave/array/Array-util.cc, liboctave/array/Array-util.h, liboctave/array/Array.cc, liboctave/array/Array.h, liboctave/array/Array3.h, liboctave/array/CColVector.cc, liboctave/array/CColVector.h, liboctave/array/CDiagMatrix.cc, liboctave/array/CDiagMatrix.h, liboctave/array/CMatrix.cc, liboctave/array/CMatrix.h, liboctave/array/CNDArray.cc, liboctave/array/CNDArray.h, liboctave/array/CRowVector.cc, liboctave/array/CRowVector.h, liboctave/array/CSparse.cc, liboctave/array/CSparse.h, liboctave/array/DiagArray2.h, liboctave/array/MArray.cc, liboctave/array/MArray.h, liboctave/array/MDiagArray2.cc, liboctave/array/MDiagArray2.h, liboctave/array/MSparse.cc, liboctave/array/MSparse.h, liboctave/array/MatrixType.cc, liboctave/array/MatrixType.h, liboctave/array/PermMatrix.h, liboctave/array/Range.cc, liboctave/array/Range.h, liboctave/array/Sparse.cc, liboctave/array/Sparse.h, liboctave/array/boolMatrix.cc, liboctave/array/boolMatrix.h, liboctave/array/boolNDArray.cc, liboctave/array/boolNDArray.h, liboctave/array/boolSparse.cc, liboctave/array/boolSparse.h, liboctave/array/chMatrix.cc, liboctave/array/chMatrix.h, liboctave/array/chNDArray.cc, liboctave/array/chNDArray.h, liboctave/array/dColVector.h, liboctave/array/dDiagMatrix.cc, liboctave/array/dDiagMatrix.h, liboctave/array/dMatrix.cc, liboctave/array/dMatrix.h, liboctave/array/dNDArray.cc, liboctave/array/dNDArray.h, liboctave/array/dRowVector.h, liboctave/array/dSparse.cc, liboctave/array/dSparse.h, liboctave/array/dim-vector.cc, liboctave/array/dim-vector.h, liboctave/array/fCColVector.cc, liboctave/array/fCColVector.h, liboctave/array/fCDiagMatrix.cc, liboctave/array/fCDiagMatrix.h, liboctave/array/fCMatrix.cc, liboctave/array/fCMatrix.h, liboctave/array/fCNDArray.cc, liboctave/array/fCNDArray.h, liboctave/array/fCRowVector.cc, liboctave/array/fCRowVector.h, liboctave/array/fColVector.h, liboctave/array/fDiagMatrix.cc, liboctave/array/fDiagMatrix.h, liboctave/array/fMatrix.cc, liboctave/array/fMatrix.h, liboctave/array/fNDArray.cc, liboctave/array/fNDArray.h, liboctave/array/fRowVector.h, liboctave/array/idx-vector.cc, liboctave/array/idx-vector.h, liboctave/array/intNDArray.cc, liboctave/array/intNDArray.h, liboctave/cruft/misc/blaswrap.c, liboctave/cruft/misc/quit.cc, liboctave/numeric/CmplxCHOL.cc, liboctave/numeric/CmplxCHOL.h, liboctave/numeric/CmplxGEPBAL.cc, liboctave/numeric/CmplxGEPBAL.h, liboctave/numeric/CmplxHESS.h, liboctave/numeric/CmplxLU.cc, liboctave/numeric/CmplxLU.h, liboctave/numeric/CmplxQR.cc, liboctave/numeric/CmplxQRP.cc, liboctave/numeric/CmplxQRP.h, liboctave/numeric/CmplxSCHUR.h, liboctave/numeric/CmplxSVD.cc, liboctave/numeric/CmplxSVD.h, liboctave/numeric/CollocWt.h, liboctave/numeric/DAE.h, liboctave/numeric/DAEFunc.h, liboctave/numeric/DAERT.h, liboctave/numeric/DAERTFunc.h, liboctave/numeric/DASPK.cc, liboctave/numeric/DASRT.cc, liboctave/numeric/DASRT.h, liboctave/numeric/DASSL.cc, liboctave/numeric/DET.h, liboctave/numeric/EIG.cc, liboctave/numeric/EIG.h, liboctave/numeric/LSODE.cc, liboctave/numeric/ODE.h, liboctave/numeric/ODEFunc.h, liboctave/numeric/ODES.h, liboctave/numeric/ODESFunc.h, liboctave/numeric/Quad.cc, liboctave/numeric/Quad.h, liboctave/numeric/SparseCmplxCHOL.h, liboctave/numeric/SparseCmplxLU.cc, liboctave/numeric/SparseCmplxLU.h, liboctave/numeric/SparseCmplxQR.cc, liboctave/numeric/SparseCmplxQR.h, liboctave/numeric/SparseQR.cc, liboctave/numeric/SparseQR.h, liboctave/numeric/SparsedbleCHOL.h, liboctave/numeric/SparsedbleLU.cc, liboctave/numeric/SparsedbleLU.h, liboctave/numeric/base-aepbal.h, liboctave/numeric/base-dae.h, liboctave/numeric/base-de.h, liboctave/numeric/base-lu.cc, liboctave/numeric/base-lu.h, liboctave/numeric/base-min.h, liboctave/numeric/base-qr.h, liboctave/numeric/bsxfun.h, liboctave/numeric/dbleCHOL.cc, liboctave/numeric/dbleCHOL.h, liboctave/numeric/dbleGEPBAL.h, liboctave/numeric/dbleHESS.h, liboctave/numeric/dbleLU.cc, liboctave/numeric/dbleLU.h, liboctave/numeric/dbleQR.cc, liboctave/numeric/dbleQRP.cc, liboctave/numeric/dbleQRP.h, liboctave/numeric/dbleSCHUR.cc, liboctave/numeric/dbleSCHUR.h, liboctave/numeric/dbleSVD.cc, liboctave/numeric/dbleSVD.h, liboctave/numeric/eigs-base.cc, liboctave/numeric/fCmplxAEPBAL.cc, liboctave/numeric/fCmplxAEPBAL.h, liboctave/numeric/fCmplxCHOL.cc, liboctave/numeric/fCmplxCHOL.h, liboctave/numeric/fCmplxGEPBAL.cc, liboctave/numeric/fCmplxGEPBAL.h, liboctave/numeric/fCmplxHESS.h, liboctave/numeric/fCmplxLU.cc, liboctave/numeric/fCmplxLU.h, liboctave/numeric/fCmplxQR.cc, liboctave/numeric/fCmplxQR.h, liboctave/numeric/fCmplxQRP.cc, liboctave/numeric/fCmplxQRP.h, liboctave/numeric/fCmplxSCHUR.cc, liboctave/numeric/fCmplxSCHUR.h, liboctave/numeric/fCmplxSVD.h, liboctave/numeric/fEIG.cc, liboctave/numeric/fEIG.h, liboctave/numeric/floatCHOL.cc, liboctave/numeric/floatCHOL.h, liboctave/numeric/floatGEPBAL.cc, liboctave/numeric/floatGEPBAL.h, liboctave/numeric/floatHESS.h, liboctave/numeric/floatLU.cc, liboctave/numeric/floatLU.h, liboctave/numeric/floatQR.cc, liboctave/numeric/floatQRP.cc, liboctave/numeric/floatQRP.h, liboctave/numeric/floatSCHUR.cc, liboctave/numeric/floatSCHUR.h, liboctave/numeric/floatSVD.cc, liboctave/numeric/floatSVD.h, liboctave/numeric/lo-mappers.cc, liboctave/numeric/lo-mappers.h, liboctave/numeric/lo-specfun.cc, liboctave/numeric/lo-specfun.h, liboctave/numeric/oct-convn.cc, liboctave/numeric/oct-fftw.cc, liboctave/numeric/oct-fftw.h, liboctave/numeric/oct-norm.cc, liboctave/numeric/oct-rand.cc, liboctave/numeric/oct-rand.h, liboctave/numeric/randgamma.c, liboctave/numeric/randgamma.h, liboctave/numeric/randmtzig.c, liboctave/numeric/randpoisson.c, liboctave/numeric/randpoisson.h, liboctave/numeric/sparse-base-chol.h, liboctave/numeric/sparse-base-lu.h, liboctave/numeric/sparse-dmsolve.cc, liboctave/operators/Sparse-diag-op-defs.h, liboctave/operators/Sparse-op-defs.h, liboctave/operators/mx-inlines.cc, liboctave/system/dir-ops.h, liboctave/system/file-ops.cc, liboctave/system/file-stat.cc, liboctave/system/file-stat.h, liboctave/system/lo-sysdep.cc, liboctave/system/lo-sysdep.h, liboctave/system/mach-info.cc, liboctave/system/mach-info.h, liboctave/system/oct-env.cc, liboctave/system/oct-group.cc, liboctave/system/oct-syscalls.cc, liboctave/system/oct-syscalls.h, liboctave/system/oct-time.h, liboctave/system/tempname.c, liboctave/util/action-container.h, liboctave/util/base-list.h, liboctave/util/cmd-edit.cc, liboctave/util/cmd-edit.h, liboctave/util/cmd-hist.cc, liboctave/util/cmd-hist.h, liboctave/util/data-conv.cc, liboctave/util/data-conv.h, liboctave/util/kpse.cc, liboctave/util/lo-array-gripes.cc, liboctave/util/lo-cieee.c, liboctave/util/lo-regexp.cc, liboctave/util/lo-utils.cc, liboctave/util/oct-alloc.cc, liboctave/util/oct-base64.cc, liboctave/util/oct-binmap.h, liboctave/util/oct-cmplx.h, liboctave/util/oct-glob.cc, liboctave/util/oct-inttypes.cc, liboctave/util/oct-inttypes.h, liboctave/util/oct-locbuf.cc, liboctave/util/oct-locbuf.h, liboctave/util/oct-mem.h, liboctave/util/oct-mutex.cc, liboctave/util/oct-refcount.h, liboctave/util/oct-shlib.cc, liboctave/util/oct-shlib.h, liboctave/util/oct-sort.cc, liboctave/util/oct-sort.h, liboctave/util/pathsearch.cc, liboctave/util/pathsearch.h, liboctave/util/sparse-util.cc, liboctave/util/str-vec.cc, liboctave/util/str-vec.h, liboctave/util/unwind-prot.h, liboctave/util/url-transfer.cc, liboctave/util/url-transfer.h: Use GNU style coding conventions.
author Rik <rik@octave.org>
date Sat, 26 Oct 2013 18:57:05 -0700
parents d63878346099
children 4197fc428c7d
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
17744
d63878346099 maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents: 15271
diff changeset
3 Copyright (C) 2002-2013 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_ODES_h)
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
24 #define octave_ODES_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 "ODESFunc.h"
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
27 #include "base-de.h"
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
28
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
29 class
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
30 ODES : public base_diff_eqn, public ODESFunc
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
31 {
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
32 public:
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
33
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
34 ODES (void)
11502
4638800cd660 delete data pointer members from liboctave ODE/DAE classes; make destuctors virtual in ODE/DAE base classes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
35 : base_diff_eqn (), ODESFunc (), xdot (), theta () { }
3984
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
36
4587
7b957b442818 [project @ 2003-11-10 15:50:39 by jwe]
jwe
parents: 4192
diff changeset
37 ODES (const ColumnVector& s, double tm, ODESFunc& f)
7b957b442818 [project @ 2003-11-10 15:50:39 by jwe]
jwe
parents: 4192
diff changeset
38 : base_diff_eqn (s, tm), ODESFunc (f), xdot (s.length (), 0.0), theta () { }
3984
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
39
4587
7b957b442818 [project @ 2003-11-10 15:50:39 by jwe]
jwe
parents: 4192
diff changeset
40 ODES (const ColumnVector& s, const ColumnVector& xtheta, double tm,
10312
cbc402e64d83 untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents: 10158
diff changeset
41 ODESFunc& f)
4587
7b957b442818 [project @ 2003-11-10 15:50:39 by jwe]
jwe
parents: 4192
diff changeset
42 : base_diff_eqn (s, tm), ODESFunc (f), xdot (s.length (), 0.0),
3984
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
43 theta (xtheta) { }
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
44
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
45 ODES (const ODES& a)
11502
4638800cd660 delete data pointer members from liboctave ODE/DAE classes; make destuctors virtual in ODE/DAE base classes
John W. Eaton <jwe@octave.org>
parents: 10312
diff changeset
46 : base_diff_eqn (a), ODESFunc (a), xdot (a.xdot), theta (a.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 ODES& operator = (const ODES& a)
17769
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
49 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
50 if (this != &a)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
51 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
52 base_diff_eqn::operator = (a);
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
53 ODESFunc::operator = (a);
3984
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
54
17769
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
55 xdot = a.xdot;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
56 theta = a.theta;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
57 }
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
58 return *this;
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
59 }
3984
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
60
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
61 ~ODES (void) { }
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 ColumnVector parameter_vector (void) { return theta; }
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 void initialize (const ColumnVector& x, double t);
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
66
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
67 void initialize (const ColumnVector& x, double t,
10312
cbc402e64d83 untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents: 10158
diff changeset
68 const ColumnVector& theta);
3984
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
69
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
70 protected:
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
71
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
72 // State vector time derivatives.
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
73 ColumnVector xdot;
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
74
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
75 // Parameter vector.
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
76 ColumnVector theta;
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
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents:
diff changeset
79 #endif