octave: libinterp/corefcn/lsode.cc annotate

annotate libinterp/corefcn/lsode.cc @ 24412:6e1d3ad32ed1 stable

doc: Fix documentation of third input to lsode() (bug #52664). * lsode.cc (Flsode): Rewrite documentation for third input t.

author	Rik <rik@octave.org>
date	Thu, 14 Dec 2017 14:38:33 -0800
parents	3ac9f9ecfae5
children	2adff1743db7

rev	line source
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	1 /*
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	2
23219 3ac9f9ecfae5 maint: Update copyright dates. John W. Eaton <jwe@octave.org> parents: 23083 diff changeset	3 Copyright (C) 1996-2017 John W. Eaton
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	4
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	5 This file is part of Octave.
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	6
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	7 Octave is free software; you can redistribute it and/or modify it
295f037b4b3e [project @ 1997-05-05 05:32: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: 7001 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: 7001 diff changeset	10 option) any later version.
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	11
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	12 Octave is distributed in the hope that it will be useful, but WITHOUT
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	15 for more details.
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	16
295f037b4b3e [project @ 1997-05-05 05:32: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: 7001 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: 7001 diff changeset	19 <http://www.gnu.org/licenses/>.
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	20
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	21 */
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	22
21724 aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef" John W. Eaton <jwe@octave.org> parents: 21301 diff changeset	23 #if defined (HAVE_CONFIG_H)
21301 40de9f8f23a6 Use '#include "config.h"' rather than <config.h>. Rik <rik@octave.org> parents: 21200 diff changeset	24 # include "config.h"
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	25 #endif
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	26
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	27 #include <string>
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	28
3567 dd8998699aa8 [project @ 2000-02-03 09:54:28 by jwe] jwe parents: 3544 diff changeset	29 #include <iomanip>
3523 b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe] jwe parents: 3419 diff changeset	30 #include <iostream>
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	31
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	32 #include "LSODE.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	33 #include "lo-mappers.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	34
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14854 diff changeset	35 #include "defun.h"
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	36 #include "error.h"
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 20990 diff changeset	37 #include "errwarn.h"
20940 48b2ad5ee801 maint: Rename oct-obj.[cc\|h] to ovl.[cc\|h] for clarity. Rik <rik@octave.org> parents: 20909 diff changeset	38 #include "ovl.h"
2968 e330cb788508 [project @ 1997-05-15 17:40:29 by jwe] jwe parents: 2928 diff changeset	39 #include "ov-fcn.h"
5729 e065f7c18bdc [project @ 2006-04-03 19:03:30 by jwe] jwe parents: 5694 diff changeset	40 #include "ov-cell.h"
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	41 #include "pager.h"
3952 945e8c160191 [project @ 2002-05-23 17:18:12 by jwe] jwe parents: 3920 diff changeset	42 #include "pr-output.h"
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	43 #include "unwind-prot.h"
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	44 #include "utils.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	45 #include "variables.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	46
3998 f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: 3997 diff changeset	47 #include "LSODE-opts.cc"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: 3997 diff changeset	48
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	49 // Global pointer for user defined function required by lsode.
2968 e330cb788508 [project @ 1997-05-15 17:40:29 by jwe] jwe parents: 2928 diff changeset	50 static octave_function *lsode_fcn;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	51
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	52 // Global pointer for optional user defined jacobian function used by lsode.
2968 e330cb788508 [project @ 1997-05-15 17:40:29 by jwe] jwe parents: 2928 diff changeset	53 static octave_function *lsode_jac;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	54
4140 303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	55 // Have we warned about imaginary values returned from user function?
303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	56 static bool warned_fcn_imaginary = false;
303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	57 static bool warned_jac_imaginary = false;
303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	58
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	59 // Is this a recursive call?
dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	60 static int call_depth = 0;
dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	61
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	62 ColumnVector
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	63 lsode_user_function (const ColumnVector& x, double t)
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	64 {
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	65 ColumnVector retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	66
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	67 octave_value_list args;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	68 args(1) = t;
4628 c0121a3b9cbe [project @ 2003-11-17 20:19:07 by jwe] jwe parents: 4140 diff changeset	69 args(0) = x;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	70
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	71 if (lsode_fcn)
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	72 {
20725 7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	73 octave_value_list tmp;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	74
20725 7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	75 try
7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	76 {
7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	77 tmp = lsode_fcn->do_multi_index_op (1, args);
7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	78 }
22327 d0562b3159c7 move more classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	79 catch (octave::execution_exception& e)
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	80 {
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 20990 diff changeset	81 err_user_supplied_eval (e, "lsode");
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	82 }
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	83
21885 0806871e3e1e maint: Prefer is_empty() rather than "length () == 0". Rik <rik@octave.org> parents: 21743 diff changeset	84 if (tmp.empty () \|\| ! tmp(0).is_defined ())
21118 3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	85 err_user_supplied_eval ("lsode");
3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	86
3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	87 if (! warned_fcn_imaginary && tmp(0).is_complex_type ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	88 {
21118 3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	89 warning ("lsode: ignoring imaginary part returned from user-supplied function");
3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	90 warned_fcn_imaginary = true;
3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	91 }
4140 303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	92
21118 3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	93 retval = tmp(0).xvector_value ("lsode: expecting user supplied function to return numeric vector");
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	94
21118 3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	95 if (retval.is_empty ())
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 20990 diff changeset	96 err_user_supplied_eval ("lsode");
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	97 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	98
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	99 return retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	100 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	101
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	102 Matrix
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	103 lsode_user_jacobian (const ColumnVector& x, double t)
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	104 {
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	105 Matrix retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	106
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	107 octave_value_list args;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	108 args(1) = t;
4628 c0121a3b9cbe [project @ 2003-11-17 20:19:07 by jwe] jwe parents: 4140 diff changeset	109 args(0) = x;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	110
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	111 if (lsode_jac)
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	112 {
20725 7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	113 octave_value_list tmp;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	114
20725 7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	115 try
7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	116 {
7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	117 tmp = lsode_jac->do_multi_index_op (1, args);
7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	118 }
22327 d0562b3159c7 move more classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	119 catch (octave::execution_exception& e)
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	120 {
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 20990 diff changeset	121 err_user_supplied_eval (e, "lsode");
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	122 }
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	123
21885 0806871e3e1e maint: Prefer is_empty() rather than "length () == 0". Rik <rik@octave.org> parents: 21743 diff changeset	124 if (tmp.empty () \|\| ! tmp(0).is_defined ())
21118 3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	125 err_user_supplied_eval ("lsode");
3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	126
3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	127 if (! warned_jac_imaginary && tmp(0).is_complex_type ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	128 {
21118 3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	129 warning ("lsode: ignoring imaginary part returned from user-supplied jacobian function");
3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	130 warned_jac_imaginary = true;
3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	131 }
4140 303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	132
21118 3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	133 retval = tmp(0).xmatrix_value ("lsode: expecting user supplied jacobian function to return numeric array");
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	134
21118 3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	135 if (retval.is_empty ())
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 20990 diff changeset	136 err_user_supplied_eval ("lsode");
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	137 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	138
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	139 return retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	140 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	141
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14854 diff changeset	142 DEFUN (lsode, args, nargout,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	143 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	144 @deftypefn {} {[@var{x}, @var{istate}, @var{msg}] =} lsode (@var{fcn}, @var{x_0}, @var{t})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	145 @deftypefnx {} {[@var{x}, @var{istate}, @var{msg}] =} lsode (@var{fcn}, @var{x_0}, @var{t}, @var{t_crit})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	146 Ordinary Differential Equation (ODE) solver.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	147
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	148 The set of differential equations to solve is
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	149 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	150 $$ {dx \over dt} = f (x, t) $$
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	151 with
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	152 $$ x(t_0) = x_0 $$
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	153 @end tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	154 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	155
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	156 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	157 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	158 dx
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	159 -- = f (x, t)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	160 dt
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	161 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	162 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	163
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	164 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	165 with
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	166
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	167 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	168 x(t_0) = x_0
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	169 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	170
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	171 @end ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	172 The solution is returned in the matrix @var{x}, with each row
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	173 corresponding to an element of the vector @var{t}. The first element
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	174 of @var{t} should be @math{t_0} and should correspond to the initial
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	175 state of the system @var{x_0}, so that the first row of the output
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	176 is @var{x_0}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	177
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	178 The first argument, @var{fcn}, is a string, inline, or function handle
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	179 that names the function @math{f} to call to compute the vector of right
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	180 hand sides for the set of equations. The function must have the form
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	181
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	182 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	183 @var{xdot} = f (@var{x}, @var{t})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	184 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	185
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	186 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	187 in which @var{xdot} and @var{x} are vectors and @var{t} is a scalar.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	188
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	189 If @var{fcn} is a two-element string array or a two-element cell array
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	190 of strings, inline functions, or function handles, the first element names
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	191 the function @math{f} described above, and the second element names a
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	192 function to compute the Jacobian of @math{f}. The Jacobian function
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	193 must have the form
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	194
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	195 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	196 @var{jac} = j (@var{x}, @var{t})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	197 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	198
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	199 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	200 in which @var{jac} is the matrix of partial derivatives
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	201 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	202 $$ J = {\partial f_i \over \partial x_j} = \left[\matrix{
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	203 {\partial f_1 \over \partial x_1}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	204 & {\partial f_1 \over \partial x_2}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	205 & \cdots
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	206 & {\partial f_1 \over \partial x_N} \cr
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	207 {\partial f_2 \over \partial x_1}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	208 & {\partial f_2 \over \partial x_2}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	209 & \cdots
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	210 & {\partial f_2 \over \partial x_N} \cr
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	211 \vdots & \vdots & \ddots & \vdots \cr
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	212 {\partial f_3 \over \partial x_1}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	213 & {\partial f_3 \over \partial x_2}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	214 & \cdots
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	215 & {\partial f_3 \over \partial x_N} \cr}\right]$$
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	216 @end tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	217 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	218
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	219 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	220 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	221 \| df_1 df_1 df_1 \|
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	222 \| ---- ---- ... ---- \|
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	223 \| dx_1 dx_2 dx_N \|
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	224 \| \|
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	225 \| df_2 df_2 df_2 \|
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	226 \| ---- ---- ... ---- \|
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	227 df_i \| dx_1 dx_2 dx_N \|
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	228 jac = ---- = \| \|
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	229 dx_j \| . . . . \|
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	230 \| . . . . \|
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	231 \| . . . . \|
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	232 \| \|
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	233 \| df_N df_N df_N \|
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	234 \| ---- ---- ... ---- \|
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	235 \| dx_1 dx_2 dx_N \|
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	236 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	237 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	238
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	239 @end ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	240
24412 6e1d3ad32ed1 doc: Fix documentation of third input to lsode() (bug #52664). Rik <rik@octave.org> parents: 23219 diff changeset	241 The second argument specifies the initial state of the system @math{x_0}. The
6e1d3ad32ed1 doc: Fix documentation of third input to lsode() (bug #52664). Rik <rik@octave.org> parents: 23219 diff changeset	242 third argument is a vector, @var{t}, specifying the time values for which a
6e1d3ad32ed1 doc: Fix documentation of third input to lsode() (bug #52664). Rik <rik@octave.org> parents: 23219 diff changeset	243 solution is sought.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	244
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	245 The fourth argument is optional, and may be used to specify a set of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	246 times that the ODE solver should not integrate past. It is useful for
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	247 avoiding difficulties with singularities and points where there is a
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	248 discontinuity in the derivative.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	249
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	250 After a successful computation, the value of @var{istate} will be 2
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	251 (consistent with the Fortran version of @sc{lsode}).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	252
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	253 If the computation is not successful, @var{istate} will be something
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	254 other than 2 and @var{msg} will contain additional information.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	255
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	256 You can use the function @code{lsode_options} to set optional
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	257 parameters for @code{lsode}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	258 @seealso{daspk, dassl, dasrt}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	259 @end deftypefn */)
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	260 {
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20892 diff changeset	261 int nargin = args.length ();
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20892 diff changeset	262
20909 03e4ddd49396 omit unnecessary nargout checks John W. Eaton <jwe@octave.org> parents: 20898 diff changeset	263 if (nargin < 3 \|\| nargin > 4)
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20892 diff changeset	264 print_usage ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	265
4140 303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	266 warned_fcn_imaginary = false;
303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	267 warned_jac_imaginary = false;
303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	268
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	269 octave::unwind_protect frame;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	270
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	271 frame.protect_var (call_depth);
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	272 call_depth++;
dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	273
dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	274 if (call_depth > 1)
20709 a2a99aaf680b eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20687 diff changeset	275 error ("lsode: invalid recursive call");
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	276
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	277 std::string fcn_name, fname, jac_name, jname;
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	278 lsode_fcn = 0;
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	279 lsode_jac = 0;
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	280
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	281 octave_value f_arg = args(0);
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	282
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	283 if (f_arg.is_cell ())
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	284 {
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	285 Cell c = f_arg.cell_value ();
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	286 if (c.numel () == 1)
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	287 f_arg = c(0);
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	288 else if (c.numel () == 2)
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	289 {
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	290 if (c(0).is_function_handle () \|\| c(0).is_inline_function ())
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	291 lsode_fcn = c(0).function_value ();
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	292 else
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	293 {
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	294 fcn_name = unique_symbol_name ("__lsode_fcn__");
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	295 fname = "function y = ";
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	296 fname.append (fcn_name);
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	297 fname.append (" (x, t) y = ");
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	298 lsode_fcn = extract_function (c(0), "lsode", fcn_name, fname,
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	299 "; endfunction");
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	300 }
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	301
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	302 if (lsode_fcn)
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	303 {
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	304 if (c(1).is_function_handle () \|\| c(1).is_inline_function ())
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	305 lsode_jac = c(1).function_value ();
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	306 else
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	307 {
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	308 jac_name = unique_symbol_name ("__lsode_jac__");
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	309 jname = "function jac = ";
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	310 jname.append (jac_name);
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	311 jname.append (" (x, t) jac = ");
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	312 lsode_jac = extract_function (c(1), "lsode", jac_name,
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	313 jname, "; endfunction");
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	314
20955 77f5591878bf maint: Use '! expr' rather than '!expr' to conform to coding guidelines. Rik <rik@octave.org> parents: 20940 diff changeset	315 if (! lsode_jac)
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	316 {
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	317 if (fcn_name.length ())
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	318 clear_function (fcn_name);
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	319 lsode_fcn = 0;
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	320 }
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	321 }
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	322 }
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	323 }
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	324 else
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	325 error ("lsode: incorrect number of elements in cell array");
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	326 }
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	327
20955 77f5591878bf maint: Use '! expr' rather than '!expr' to conform to coding guidelines. Rik <rik@octave.org> parents: 20940 diff changeset	328 if (! lsode_fcn && ! f_arg.is_cell ())
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	329 {
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	330 if (f_arg.is_function_handle () \|\| f_arg.is_inline_function ())
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	331 lsode_fcn = f_arg.function_value ();
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	332 else
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	333 {
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	334 switch (f_arg.rows ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	335 {
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	336 case 1:
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	337 do
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	338 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	339 fcn_name = unique_symbol_name ("__lsode_fcn__");
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	340 fname = "function y = ";
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	341 fname.append (fcn_name);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	342 fname.append (" (x, t) y = ");
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	343 lsode_fcn = extract_function (f_arg, "lsode", fcn_name,
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	344 fname, "; endfunction");
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	345 }
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	346 while (0);
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	347 break;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	348
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	349 case 2:
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	350 {
20990 fc9cca99b2de Deprecate all_strings, replace with string_vector_value. Rik <rik@octave.org> parents: 20974 diff changeset	351 string_vector tmp = f_arg.string_vector_value ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	352
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	353 fcn_name = unique_symbol_name ("__lsode_fcn__");
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	354 fname = "function y = ";
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	355 fname.append (fcn_name);
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	356 fname.append (" (x, t) y = ");
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	357 lsode_fcn = extract_function (tmp(0), "lsode", fcn_name,
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	358 fname, "; endfunction");
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	359
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	360 if (lsode_fcn)
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	361 {
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	362 jac_name = unique_symbol_name ("__lsode_jac__");
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	363 jname = "function jac = ";
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	364 jname.append (jac_name);
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	365 jname.append (" (x, t) jac = ");
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	366 lsode_jac = extract_function (tmp(1), "lsode",
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	367 jac_name, jname,
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	368 "; endfunction");
5729 e065f7c18bdc [project @ 2006-04-03 19:03:30 by jwe] jwe parents: 5694 diff changeset	369
20955 77f5591878bf maint: Use '! expr' rather than '!expr' to conform to coding guidelines. Rik <rik@octave.org> parents: 20940 diff changeset	370 if (! lsode_jac)
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	371 {
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	372 if (fcn_name.length ())
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	373 clear_function (fcn_name);
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	374 lsode_fcn = 0;
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	375 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	376 }
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	377 }
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	378 break;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	379
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	380 default:
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	381 error ("lsode: first arg should be a string or 2-element string array");
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	382 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	383 }
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	384 }
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	385
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	386 if (! lsode_fcn)
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	387 error ("lsode: FCN argument is not a valid function name or handle");
20687 5f04bfc7c17a backout changeset 18f38ed43962 John W. Eaton <jwe@octave.org> parents: 20682 diff changeset	388
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	389 ColumnVector state = args(1).xvector_value ("lsode: initial state X_0 must be a vector");
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	390 ColumnVector out_times = args(2).xvector_value ("lsode: output time variable T must be a vector");
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	391
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	392 ColumnVector crit_times;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	393
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	394 int crit_times_set = 0;
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	395 if (nargin > 3)
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	396 {
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	397 crit_times = args(3).xvector_value ("lsode: list of critical times T_CRIT must be a vector");
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	398
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	399 crit_times_set = 1;
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	400 }
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	401
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	402 double tzero = out_times (0);
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	403
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	404 ODEFunc func (lsode_user_function);
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	405 if (lsode_jac)
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	406 func.set_jacobian_function (lsode_user_jacobian);
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	407
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	408 LSODE ode (state, tzero, func);
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	409
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	410 ode.set_options (lsode_opts);
3243 dd00769643ae [project @ 1999-05-28 04:19:00 by jwe] jwe parents: 3131 diff changeset	411
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	412 Matrix output;
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	413 if (crit_times_set)
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	414 output = ode.integrate (out_times, crit_times);
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	415 else
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	416 output = ode.integrate (out_times);
5729 e065f7c18bdc [project @ 2006-04-03 19:03:30 by jwe] jwe parents: 5694 diff changeset	417
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	418 if (fcn_name.length ())
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	419 clear_function (fcn_name);
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	420 if (jac_name.length ())
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	421 clear_function (jac_name);
3997 d4091aff6468 [project @ 2002-07-17 18:00:06 by jwe] jwe parents: 3991 diff changeset	422
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	423 std::string msg = ode.error_message ();
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	424
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20892 diff changeset	425 octave_value_list retval (3);
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20892 diff changeset	426
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	427 if (ode.integration_ok ())
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	428 retval(0) = output;
20892 c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	429 else if (nargout < 2)
c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	430 error ("lsode: %s", msg.c_str ());
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	431 else
20892 c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	432 retval(0) = Matrix ();
3959 5a848097fe4a [project @ 2002-05-24 17:58:16 by jwe] jwe parents: 3957 diff changeset	433
20892 c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	434 retval(1) = static_cast<double> (ode.integration_state ());
c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	435 retval(2) = msg;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	436
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	437 return retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	438 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	439
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	440 /*
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	441
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	442 ## dassl-1.m
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	443 ##
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	444 ## Test lsode() function
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	445 ##
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	446 ## Author: David Billinghurst (David.Billinghurst@riotinto.com.au)
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	447 ## Comalco Research and Technology
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	448 ## 20 May 1998
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	449 ##
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	450 ## Problem
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	451 ##
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	452 ## y1' = -y2, y1(0) = 1
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	453 ## y2' = y1, y2(0) = 0
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	454 ##
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	455 ## Solution
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	456 ##
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	457 ## y1(t) = cos(t)
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	458 ## y2(t) = sin(t)
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	459 ##
14085 4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 13915 diff changeset	460 %!function xdot = __f (x, t)
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	461 %! xdot = [-x(2); x(1)];
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	462 %!endfunction
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	463 %!test
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	464 %!
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	465 %! x0 = [1; 0];
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	466 %! xdot0 = [0; 1];
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	467 %! t = (0:1:10)';
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	468 %!
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	469 %! tol = 500 * lsode_options ("relative tolerance");
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	470 %!
14085 4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 13915 diff changeset	471 %! x = lsode ("__f", x0, t);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	472 %!
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	473 %! y = [cos(t), sin(t)];
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	474 %!
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	475 %! assert (x, y, tol);
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	476
14085 4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 13915 diff changeset	477 %!function xdotdot = __f (x, t)
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	478 %! xdotdot = [x(2); -x(1)];
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	479 %!endfunction
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	480 %!test
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	481 %!
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	482 %! x0 = [1; 0];
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	483 %! t = [0; 2*pi];
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	484 %! tol = 100 * dassl_options ("relative tolerance");
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	485 %!
14085 4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 13915 diff changeset	486 %! x = lsode ("__f", x0, t);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	487 %!
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	488 %! y = [1, 0; 1, 0];
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	489 %!
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	490 %! assert (x, y, tol);
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	491
14085 4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 13915 diff changeset	492 %!function xdot = __f (x, t)
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	493 %! xdot = x;
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	494 %!endfunction
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	495 %!test
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	496 %!
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	497 %! x0 = 1;
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	498 %! t = [0; 1];
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	499 %! tol = 100 * dassl_options ("relative tolerance");
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	500 %!
14085 4e8f23ccadce test: Use internal prefix "__" for %!functions to avoid polluting workspace Rik <octave@nomad.inbox5.com> parents: 13915 diff changeset	501 %! x = lsode ("__f", x0, t);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	502 %!
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	503 %! y = [1; e];
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	504 %!
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	505 %! assert (x, y, tol);
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	506
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	507 %!test
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	508 %! lsode_options ("absolute tolerance", eps);
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	509 %! assert (lsode_options ("absolute tolerance") == eps);
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	510
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	511 %!error lsode_options ("foo", 1, 2)
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	512 */

Mercurial > octave

annotate libinterp/corefcn/lsode.cc @ 24412:6e1d3ad32ed1 stable