Mercurial > hg > octave-max
annotate liboctave/ODEFunc.h @ 14327:4d917a6a858b stable
doc: Use Octave coding conventions in @example blocks of docstrings.
* accumarray.m, accumdim.m, bar.m, base2dec.m, bincoeff.m, bitcmp.m, bitset.m,
celldisp.m, chop.m, clabel.m, cloglog.m, colon.m, compass.m, computer.m,
contour3.m, contourc.m, corr.m, cstrcat.m, ctime.m, cylinder.m, date.m,
dec2base.m, demo.m, dir.m, dlmwrite.m, expm.m, ezcontourf.m, ezcontour.m,
ezmeshc.m, ezmesh.m, ezplot.m, ezsurfc.m, ezsurf.m, feather.m, findobj.m,
flipdim.m, fplot.m, genvarname.m, getfield.m, hankel.m, hilb.m, hist.m,
idivide.m, index.m, int2str.m, interp1.m, is_leap_year.m, ismember.m,
isocolors.m, isonormals.m, isosurface.m, kurtosis.m, legendre.m, linkprop.m,
logit.m, logm.m, __makeinfo__.m, __marching_cube__.m, median.m, mkoctfile.m,
moment.m, mpoles.m, orderfields.m, pcg.m, pcr.m, plot3.m, plotmatrix.m,
polyaffine.m, polygcd.m, poly.m, polyout.m, print.m, qp.m, quadgk.m, qzhess.m,
randi.m, rat.m, refreshdata.m, residue.m, rose.m, rot90.m, saveas.m, saveobj.m,
shiftdim.m, skewness.m, spaugment.m, spdiags.m, sqp.m, stem.m, str2num.m,
strcat.m, strjust.m, strread.m, strsplit.m, structfun.m, subplot.m,
subsindex.m, substruct.m, surfl.m, surfnorm.m, svds.m, uimenu.m, union.m,
voronoi.m, warning_ids.m, wblpdf.m: Use Octave coding conventions in
@example blocks of docstrings.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Sat, 04 Feb 2012 22:12:50 -0800 |
| parents | 72c96de7a403 |
| children |
| rev | line source |
|---|---|
| 3 | 1 /* |
| 2 | |
|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
3 Copyright (C) 1993-2012 John W. Eaton |
| 3 | 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 | |
| 7016 | 9 Free Software Foundation; either version 3 of the License, or (at your |
| 10 option) any later version. | |
| 3 | 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 | |
| 7016 | 18 along with Octave; see the file COPYING. If not, see |
| 19 <http://www.gnu.org/licenses/>. | |
| 3 | 20 |
| 21 */ | |
| 22 | |
| 382 | 23 #if !defined (octave_ODEFunc_h) |
| 24 #define octave_ODEFunc_h 1 | |
| 25 | |
| 465 | 26 class Matrix; |
| 27 class ColumnVector; | |
| 3 | 28 |
| 1861 | 29 class |
| 30 ODEFunc | |
| 3 | 31 { |
| 32 public: | |
| 33 | |
| 1536 | 34 typedef ColumnVector (*ODERHSFunc) (const ColumnVector&, double); |
| 35 typedef Matrix (*ODEJacFunc) (const ColumnVector&, double); | |
| 36 | |
| 37 ODEFunc (void) | |
| 4049 | 38 : fun (0), jac (0), reset (true) { } |
| 532 | 39 |
| 1536 | 40 ODEFunc (ODERHSFunc f) |
| 4049 | 41 : fun (f), jac (0), reset (true) { } |
| 3 | 42 |
| 1536 | 43 ODEFunc (ODERHSFunc f, ODEJacFunc j) |
| 4049 | 44 : fun (f), jac (j), reset (true) { } |
| 3 | 45 |
| 1536 | 46 ODEFunc (const ODEFunc& a) |
| 4049 | 47 : fun (a.fun), jac (a.jac), reset (true) { } |
| 3 | 48 |
| 1536 | 49 ODEFunc& operator = (const ODEFunc& a) |
| 50 { | |
| 1844 | 51 if (this != &a) |
|
10312
cbc402e64d83
untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents:
10158
diff
changeset
|
52 { |
|
cbc402e64d83
untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents:
10158
diff
changeset
|
53 fun = a.fun; |
|
cbc402e64d83
untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents:
10158
diff
changeset
|
54 jac = a.jac; |
|
cbc402e64d83
untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents:
10158
diff
changeset
|
55 reset = a.reset; |
|
cbc402e64d83
untabify liboctave header files
John W. Eaton <jwe@octave.org>
parents:
10158
diff
changeset
|
56 } |
| 1536 | 57 return *this; |
| 58 } | |
| 3 | 59 |
|
11504
81ff63e43f54
really make destuctors virtual in ODE/DAE base classes
John W. Eaton <jwe@octave.org>
parents:
10312
diff
changeset
|
60 virtual ~ODEFunc (void) { } |
| 1861 | 61 |
| 1536 | 62 ODERHSFunc function (void) const { return fun; } |
| 63 | |
| 64 ODEFunc& set_function (ODERHSFunc f) | |
| 65 { | |
| 66 fun = f; | |
| 4049 | 67 reset = true; |
| 1536 | 68 return *this; |
| 69 } | |
| 3 | 70 |
| 1536 | 71 ODEJacFunc jacobian_function (void) const { return jac; } |
| 3 | 72 |
| 1536 | 73 ODEFunc& set_jacobian_function (ODEJacFunc j) |
| 74 { | |
| 75 jac = j; | |
| 4049 | 76 reset = true; |
| 1536 | 77 return *this; |
| 78 } | |
| 3 | 79 |
| 80 protected: | |
| 81 | |
| 82 ODERHSFunc fun; | |
| 83 ODEJacFunc jac; | |
| 4049 | 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; | |
| 382 | 91 }; |
| 3 | 92 |
| 93 #endif |