octave: libinterp/corefcn/dasrt.cc annotate

annotate libinterp/corefcn/dasrt.cc @ 30896:c9788d7f6e65

maint: Use "fcn" as preferred abbreviation for "function" in libinterp/. * __eigs__.cc, bsxfun.cc, cellfun.cc, daspk.cc, dasrt.cc, dassl.cc, data.cc, debug.cc, error.cc, graphics.cc, graphics.in.h, gzfstream.h, ls-hdf5.cc, lsode.cc, max.cc, oct-opengl.h, quad.cc, strfns.cc, utils.cc, utils.h, variables.cc, __ode15__.cc, gzip.cc, cdef-manager.cc, ov-fcn-handle.cc, ov-java.cc, ov-usr-fcn.cc, bp-table.cc, bp-table.h, lex.h, lex.ll, oct-parse.yy, pt-eval.cc: Replace "func", "fun", "fn" in documentation and variable names with "fcn".

author	Rik <rik@octave.org>
date	Tue, 05 Apr 2022 08:33:58 -0700
parents	08b08b7f05b2
children	e88a07dec498

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ////////////////////////////////////////////////////////////////////////
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 //
30564 796f54d4ddbf update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	3 // Copyright (C) 2002-2022 The Octave Project Developers
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	4 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 // See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 // distribution or <https://octave.org/copyright/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	7 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	9 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	14 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	19 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	22 // <https://www.gnu.org/licenses/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ////////////////////////////////////////////////////////////////////////
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	25
21724 aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef" John W. Eaton <jwe@octave.org> parents: 21301 diff changeset	26 #if defined (HAVE_CONFIG_H)
21301 40de9f8f23a6 Use '#include "config.h"' rather than <config.h>. Rik <rik@octave.org> parents: 21200 diff changeset	27 # include "config.h"
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	28 #endif
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	29
26864 041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	30 #include <list>
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	31 #include <string>
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	32
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	33 #include "DASRT.h"
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	34 #include "lo-mappers.h"
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	35
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14854 diff changeset	36 #include "defun.h"
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	37 #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	38 #include "errwarn.h"
26864 041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	39 #include "interpreter-private.h"
20940 48b2ad5ee801 maint: Rename oct-obj.[cc\|h] to ovl.[cc\|h] for clarity. Rik <rik@octave.org> parents: 20918 diff changeset	40 #include "ovl.h"
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	41 #include "ov-fcn.h"
5729 e065f7c18bdc [project @ 2006-04-03 19:03:30 by jwe] jwe parents: 5694 diff changeset	42 #include "ov-cell.h"
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	43 #include "pager.h"
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	44 #include "parse.h"
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	45 #include "unwind-prot.h"
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	46 #include "utils.h"
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	47 #include "variables.h"
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	48
3998 f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: 3997 diff changeset	49 #include "DASRT-opts.cc"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: 3997 diff changeset	50
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	51 OCTAVE_NAMESPACE_BEGIN
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	52
4115 fc2048d4cd21 [project @ 2002-10-22 21:28:42 by jwe] jwe parents: 4052 diff changeset	53 // Global pointers for user defined function required by dasrt.
26864 041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	54 static octave_value dasrt_fcn;
041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	55 static octave_value dasrt_jac;
041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	56 static octave_value dasrt_cf;
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	57
4140 303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	58 // 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	59 static bool warned_fcn_imaginary = false;
303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	60 static bool warned_jac_imaginary = false;
303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	61 static bool warned_cf_imaginary = false;
303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	62
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	63 // Is this a recursive call?
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	64 static int call_depth = 0;
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	65
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	66 static ColumnVector
4628 c0121a3b9cbe [project @ 2003-11-17 20:19:07 by jwe] jwe parents: 4140 diff changeset	67 dasrt_user_f (const ColumnVector& x, const ColumnVector& xdot,
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	68 double t, octave_idx_type&)
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	69 {
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	70 ColumnVector retval;
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	71
30723 08b08b7f05b2 Replace direct calls to C library assert() with Octave specialty functions in libinterp/ (bug #61753) Arun Giridhar <arungiridhar@gmail.com> and Rik <rik@octave.org> parents: 30564 diff changeset	72 error_unless (x.numel () == xdot.numel ());
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	73
4628 c0121a3b9cbe [project @ 2003-11-17 20:19:07 by jwe] jwe parents: 4140 diff changeset	74 octave_value_list args;
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	75
3993 f23bc69132cc [project @ 2002-07-16 20:18:56 by jwe] jwe parents: 3992 diff changeset	76 args(2) = t;
4628 c0121a3b9cbe [project @ 2003-11-17 20:19:07 by jwe] jwe parents: 4140 diff changeset	77 args(1) = xdot;
c0121a3b9cbe [project @ 2003-11-17 20:19:07 by jwe] jwe parents: 4140 diff changeset	78 args(0) = x;
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	79
26864 041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	80 if (dasrt_fcn.is_defined ())
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	81 {
20725 7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	82 octave_value_list tmp;
7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	83
7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	84 try
7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	85 {
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	86 tmp = feval (dasrt_fcn, args, 1);
20725 7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	87 }
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	88 catch (execution_exception& ee)
20725 7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	89 {
29163 8f67ad8b3103 maint: Updating naming conventions for exceptions and use const where possible. Rik <rik@octave.org> parents: 28817 diff changeset	90 err_user_supplied_eval (ee, "dasrt");
20725 7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	91 }
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	92
21885 0806871e3e1e maint: Prefer is_empty() rather than "length () == 0". Rik <rik@octave.org> parents: 21743 diff changeset	93 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	94 err_user_supplied_eval ("dasrt");
3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	95
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23577 diff changeset	96 if (! warned_fcn_imaginary && tmp(0).iscomplex ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	97 {
21118 3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	98 warning ("dasrt: 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	99 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	100 }
4140 303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	101
21118 3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	102 retval = tmp(0).vector_value ();
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	103
23577 80c42f4cca13 maint: Deprecate is_empty and replace with isempty. Rik <rik@octave.org> parents: 23576 diff changeset	104 if (retval.isempty ())
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 20990 diff changeset	105 err_user_supplied_eval ("dasrt");
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	106 }
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	107
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	108 return retval;
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	109 }
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	110
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	111 static ColumnVector
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	112 dasrt_user_cf (const ColumnVector& x, double t)
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	113 {
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	114 ColumnVector retval;
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	115
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	116 octave_value_list args;
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	117
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	118 args(1) = t;
4628 c0121a3b9cbe [project @ 2003-11-17 20:19:07 by jwe] jwe parents: 4140 diff changeset	119 args(0) = x;
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	120
26864 041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	121 if (dasrt_cf.is_defined ())
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	122 {
20725 7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	123 octave_value_list tmp;
7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	124
7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	125 try
7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	126 {
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	127 tmp = feval (dasrt_cf, args, 1);
20725 7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	128 }
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	129 catch (execution_exception& ee)
20725 7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	130 {
29163 8f67ad8b3103 maint: Updating naming conventions for exceptions and use const where possible. Rik <rik@octave.org> parents: 28817 diff changeset	131 err_user_supplied_eval (ee, "dasrt");
20725 7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	132 }
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	133
21885 0806871e3e1e maint: Prefer is_empty() rather than "length () == 0". Rik <rik@octave.org> parents: 21743 diff changeset	134 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	135 err_user_supplied_eval ("dasrt");
3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	136
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23577 diff changeset	137 if (! warned_cf_imaginary && tmp(0).iscomplex ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	138 {
21118 3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	139 warning ("dasrt: ignoring imaginary part returned from user-supplied constraint function");
3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	140 warned_cf_imaginary = true;
3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	141 }
4140 303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	142
21118 3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	143 retval = tmp(0).vector_value ();
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	144
23577 80c42f4cca13 maint: Deprecate is_empty and replace with isempty. Rik <rik@octave.org> parents: 23576 diff changeset	145 if (retval.isempty ())
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 20990 diff changeset	146 err_user_supplied_eval ("dasrt");
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	147 }
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	148
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	149 return retval;
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	150 }
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	151
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	152 static Matrix
3993 f23bc69132cc [project @ 2002-07-16 20:18:56 by jwe] jwe parents: 3992 diff changeset	153 dasrt_user_j (const ColumnVector& x, const ColumnVector& xdot,
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	154 double t, double cj)
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	155 {
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	156 Matrix retval;
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	157
30723 08b08b7f05b2 Replace direct calls to C library assert() with Octave specialty functions in libinterp/ (bug #61753) Arun Giridhar <arungiridhar@gmail.com> and Rik <rik@octave.org> parents: 30564 diff changeset	158 error_unless (x.numel () == xdot.numel ());
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	159
3993 f23bc69132cc [project @ 2002-07-16 20:18:56 by jwe] jwe parents: 3992 diff changeset	160 octave_value_list args;
f23bc69132cc [project @ 2002-07-16 20:18:56 by jwe] jwe parents: 3992 diff changeset	161
f23bc69132cc [project @ 2002-07-16 20:18:56 by jwe] jwe parents: 3992 diff changeset	162 args(3) = cj;
f23bc69132cc [project @ 2002-07-16 20:18:56 by jwe] jwe parents: 3992 diff changeset	163 args(2) = t;
4628 c0121a3b9cbe [project @ 2003-11-17 20:19:07 by jwe] jwe parents: 4140 diff changeset	164 args(1) = xdot;
c0121a3b9cbe [project @ 2003-11-17 20:19:07 by jwe] jwe parents: 4140 diff changeset	165 args(0) = x;
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	166
26864 041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	167 if (dasrt_jac.is_defined ())
3993 f23bc69132cc [project @ 2002-07-16 20:18:56 by jwe] jwe parents: 3992 diff changeset	168 {
20725 7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	169 octave_value_list tmp;
7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	170
7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	171 try
7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	172 {
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	173 tmp = feval (dasrt_jac, args, 1);
20725 7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	174 }
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	175 catch (execution_exception& ee)
20725 7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	176 {
29163 8f67ad8b3103 maint: Updating naming conventions for exceptions and use const where possible. Rik <rik@octave.org> parents: 28817 diff changeset	177 err_user_supplied_eval (ee, "dasrt");
20725 7164a69472dd eliminate more uses of error state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	178 }
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	179
3993 f23bc69132cc [project @ 2002-07-16 20:18:56 by jwe] jwe parents: 3992 diff changeset	180 int tlen = tmp.length ();
21118 3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	181 if (tlen == 0 \|\| ! tmp(0).is_defined ())
3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	182 err_user_supplied_eval ("dasrt");
3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	183
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23577 diff changeset	184 if (! warned_jac_imaginary && tmp(0).iscomplex ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	185 {
21118 3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	186 warning ("dasrt: 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	187 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	188 }
4140 303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	189
21118 3ac9f47fb04b Invert pattern if/code/else/err_XXX to if !/err_XXX/code. Rik <rik@octave.org> parents: 21100 diff changeset	190 retval = tmp(0).matrix_value ();
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	191
23577 80c42f4cca13 maint: Deprecate is_empty and replace with isempty. Rik <rik@octave.org> parents: 23576 diff changeset	192 if (retval.isempty ())
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 20990 diff changeset	193 err_user_supplied_eval ("dasrt");
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	194 }
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	195
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	196 return retval;
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	197 }
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	198
23699 b29904962d2d deprecate some global functions that access the symbol table John W. Eaton <jwe@octave.org> parents: 23581 diff changeset	199 DEFMETHOD (dasrt, interp, args, nargout,
b29904962d2d deprecate some global functions that access the symbol table John W. Eaton <jwe@octave.org> parents: 23581 diff changeset	200 doc: /* -- texinfo --
24211 7b74355c8e9d Correct calling forms of dasrt in docstring. Rik <rik@octave.org> parents: 24205 diff changeset	201 @deftypefn {} {[@var{x}, @var{xdot}, @var{t_out}, @var{istat}, @var{msg}] =} dasrt (@var{fcn}, @var{g}, @var{x_0}, @var{xdot_0}, @var{t})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	202 @deftypefnx {} {@dots{} =} dasrt (@var{fcn}, @var{g}, @var{x_0}, @var{xdot_0}, @var{t}, @var{t_crit})
24211 7b74355c8e9d Correct calling forms of dasrt in docstring. Rik <rik@octave.org> parents: 24205 diff changeset	203 @deftypefnx {} {@dots{} =} dasrt (@var{fcn}, @var{x_0}, @var{xdot_0}, @var{t})
7b74355c8e9d Correct calling forms of dasrt in docstring. Rik <rik@octave.org> parents: 24205 diff changeset	204 @deftypefnx {} {@dots{} =} dasrt (@var{fcn}, @var{x_0}, @var{xdot_0}, @var{t}, @var{t_crit})
25106 d7ad543255c5 doc: Shorten very long first sentences of docstrings (bug #53388). Rik <rik@octave.org> parents: 25054 diff changeset	205 Solve a set of differential-algebraic equations.
d7ad543255c5 doc: Shorten very long first sentences of docstrings (bug #53388). Rik <rik@octave.org> parents: 25054 diff changeset	206
d7ad543255c5 doc: Shorten very long first sentences of docstrings (bug #53388). Rik <rik@octave.org> parents: 25054 diff changeset	207 @code{dasrt} solves the set of equations
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	208 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	209 $$ 0 = f (x, \dot{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	210 with
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	211 $$ x(t_0) = x_0, \dot{x}(t_0) = \dot{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	212 @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	213 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	214
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	215 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	216 0 = f (x, xdot, t)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	217 @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	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 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	220 with
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	221
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	222 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	223 x(t_0) = x_0, xdot(t_0) = xdot_0
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	224 @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	225
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	226 @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	227 with functional stopping criteria (root solving).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	228
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	229 The solution is returned in the matrices @var{x} and @var{xdot},
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	230 with each row in the result matrices corresponding to one of the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	231 elements in the vector @var{t_out}. The first element of @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	232 should be @math{t_0} and correspond to the initial state of the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	233 system @var{x_0} and its derivative @var{xdot_0}, so that the first
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	234 row of the output @var{x} is @var{x_0} and the first row
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	235 of the output @var{xdot} is @var{xdot_0}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	236
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	237 The vector @var{t} provides an upper limit on the length of the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	238 integration. If the stopping condition is met, the vector
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	239 @var{t_out} will be shorter than @var{t}, and the final element of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	240 @var{t_out} will be the point at which the stopping condition was met,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	241 and may not correspond to any element of the vector @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	242
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	243 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	244 that names the function @math{f} to call to compute the vector of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	245 residuals for the set of equations. It 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	246
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	247 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	248 @var{res} = f (@var{x}, @var{xdot}, @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	249 @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	250
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	251 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	252 in which @var{x}, @var{xdot}, and @var{res} are vectors, and @var{t} 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	253 scalar.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	254
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	255 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	256 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	257 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	258 function to compute the modified Jacobian
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	259
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	260 @tex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	261 $$
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	262 J = {\partial f \over \partial x}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	263 + c {\partial f \over \partial \dot{x}}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	264 $$
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	265 @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	266 @ifnottex
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	267
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	268 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	269 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	270 df df
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	271 jac = -- + c ------
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	272 dx d xdot
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	273 @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	274 @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	275
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	276 @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	277
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	278 The modified Jacobian 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	279
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	280 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	281 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	282
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	283 @var{jac} = j (@var{x}, @var{xdot}, @var{t}, @var{c})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	284
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	285 @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	286 @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	287
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	288 The optional second argument names a function that defines the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	289 constraint functions whose roots are desired during the integration.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	290 This 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	291
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	292 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	293 @var{g_out} = g (@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	294 @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	295
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	296 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	297 and return a vector of the constraint function values.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	298 If the value of any of the constraint functions changes sign, @sc{dasrt}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	299 will attempt to stop the integration at the point of the sign change.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	300
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	301 If the name of the constraint function is omitted, @code{dasrt} solves
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	302 the same problem as @code{daspk} or @code{dassl}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	303
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	304 Note that because of numerical errors in the constraint functions
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	305 due to round-off and integration error, @sc{dasrt} may return false
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	306 roots, or return the same root at two or more nearly equal values of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	307 @var{T}. If such false roots are suspected, the user should consider
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	308 smaller error tolerances or higher precision in the evaluation of the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	309 constraint functions.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	310
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	311 If a root of some constraint function defines the end of the problem,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	312 the input to @sc{dasrt} should nevertheless allow integration to a
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	313 point slightly past that root, so that @sc{dasrt} can locate the root
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	314 by interpolation.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	315
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	316 The third and fourth arguments to @code{dasrt} specify 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	317 condition of the states and their derivatives, and the fourth argument
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	318 specifies a vector of output times at which the solution is desired,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	319 including the time corresponding to the initial condition.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	320
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	321 The set of initial states and derivatives are not strictly required to
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	322 be consistent. In practice, however, @sc{dassl} is not very good at
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	323 determining a consistent set for you, so it is best if you ensure that
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	324 the initial values result in the function evaluating to zero.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	325
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	326 The sixth 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	327 times that the DAE 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	328 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	329 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	330
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	331 After a successful computation, the value of @var{istate} will be
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	332 greater than zero (consistent with the Fortran version of @sc{dassl}).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	333
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	334 If the computation is not successful, the value of @var{istate} will be
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	335 less than zero 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	336
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	337 You can use the function @code{dasrt_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	338 parameters for @code{dasrt}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	339 @seealso{dasrt_options, daspk, dasrt, lsode}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21885 diff changeset	340 @end deftypefn */)
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	341 {
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20892 diff changeset	342 int nargin = args.length ();
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20892 diff changeset	343
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20892 diff changeset	344 if (nargin < 4 \|\| nargin > 6)
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20892 diff changeset	345 print_usage ();
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	346
4140 303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	347 warned_fcn_imaginary = false;
303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	348 warned_jac_imaginary = false;
303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	349 warned_cf_imaginary = false;
303b28a7a7e4 [project @ 2002-11-01 02:53:13 by jwe] jwe parents: 4122 diff changeset	350
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20892 diff changeset	351 octave_value_list retval (5);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20892 diff changeset	352
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	353 unwind_protect_var<int> restore_var (call_depth);
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	354 call_depth++;
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	355
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	356 if (call_depth > 1)
20957 9db35d2042be maint: eliminate special cases of statements after error. Rik <rik@octave.org> parents: 20940 diff changeset	357 error ("dasrt: invalid recursive call");
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	358
20812 d9ca869ca124 maint: Clean-up more instances of print_usage(). Rik <rik@octave.org> parents: 20802 diff changeset	359 int argp = 0;
5729 e065f7c18bdc [project @ 2006-04-03 19:03:30 by jwe] jwe parents: 5694 diff changeset	360 std::string fcn_name, fname, jac_name, jname;
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	361
26864 041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	362 dasrt_fcn = octave_value ();
041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	363 dasrt_jac = octave_value ();
041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	364 dasrt_cf = octave_value ();
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	365
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	366 // Check all the arguments. Are they the right animals?
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	367
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	368 // Here's where I take care of f and j in one shot:
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	369
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	370 octave_value f_arg = args(0);
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	371
26864 041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	372 std::list<std::string> fcn_param_names ({"x", "xdot", "t"});
041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	373 std::list<std::string> jac_param_names ({"x", "xdot", "t", "cj"});
041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	374
23576 00e518162fda maint: Deprecate is_cell and replace with iscell. Rik <rik@octave.org> parents: 23473 diff changeset	375 if (f_arg.iscell ())
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	376 {
5729 e065f7c18bdc [project @ 2006-04-03 19:03:30 by jwe] jwe parents: 5694 diff changeset	377 Cell c = f_arg.cell_value ();
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20229 diff changeset	378 if (c.numel () == 1)
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	379 f_arg = c(0);
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20229 diff changeset	380 else if (c.numel () == 2)
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	381 {
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	382 dasrt_fcn = get_function_handle (interp, c(0), fcn_param_names);
5729 e065f7c18bdc [project @ 2006-04-03 19:03:30 by jwe] jwe parents: 5694 diff changeset	383
26864 041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	384 if (dasrt_fcn.is_defined ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	385 {
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	386 dasrt_jac = get_function_handle (interp, c(1), jac_param_names);
5729 e065f7c18bdc [project @ 2006-04-03 19:03:30 by jwe] jwe parents: 5694 diff changeset	387
26864 041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	388 if (dasrt_jac.is_undefined ())
041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	389 dasrt_fcn = octave_value ();
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	390 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	391 }
5729 e065f7c18bdc [project @ 2006-04-03 19:03:30 by jwe] jwe parents: 5694 diff changeset	392 else
20957 9db35d2042be maint: eliminate special cases of statements after error. Rik <rik@octave.org> parents: 20940 diff changeset	393 error ("dasrt: incorrect number of elements in cell array");
5729 e065f7c18bdc [project @ 2006-04-03 19:03:30 by jwe] jwe parents: 5694 diff changeset	394 }
e065f7c18bdc [project @ 2006-04-03 19:03:30 by jwe] jwe parents: 5694 diff changeset	395
26864 041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	396 if (dasrt_fcn.is_undefined () && ! f_arg.iscell ())
5729 e065f7c18bdc [project @ 2006-04-03 19:03:30 by jwe] jwe parents: 5694 diff changeset	397 {
e065f7c18bdc [project @ 2006-04-03 19:03:30 by jwe] jwe parents: 5694 diff changeset	398 if (f_arg.is_function_handle () \|\| f_arg.is_inline_function ())
26864 041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	399 dasrt_fcn = f_arg;
5729 e065f7c18bdc [project @ 2006-04-03 19:03:30 by jwe] jwe parents: 5694 diff changeset	400 else
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	401 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	402 switch (f_arg.rows ())
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	403 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	404 case 1:
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	405 dasrt_fcn = get_function_handle (interp, f_arg, fcn_param_names);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	406 break;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	407
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	408 case 2:
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	409 {
26864 041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	410 string_vector tmp = f_arg.string_vector_value ();
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	411
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	412 dasrt_fcn = get_function_handle (interp, tmp(0),
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	413 fcn_param_names);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	414
26864 041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	415 if (dasrt_fcn.is_defined ())
20557 b10432a40432 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20428 diff changeset	416 {
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	417 dasrt_jac = get_function_handle (interp, tmp(1),
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	418 jac_param_names);
5729 e065f7c18bdc [project @ 2006-04-03 19:03:30 by jwe] jwe parents: 5694 diff changeset	419
26864 041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	420 if (dasrt_jac.is_undefined ())
041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	421 dasrt_fcn = octave_value ();
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	422 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	423 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	424 break;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	425
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	426 default:
20957 9db35d2042be maint: eliminate special cases of statements after error. Rik <rik@octave.org> parents: 20940 diff changeset	427 error ("dasrt: 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	428 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	429 }
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	430 }
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	431
26864 041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	432 if (dasrt_fcn.is_undefined ())
041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	433 error ("dasrt: FCN argument is not a valid function name or handle");
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	434
30896 c9788d7f6e65 maint: Use "fcn" as preferred abbreviation for "function" in libinterp/. Rik <rik@octave.org> parents: 30723 diff changeset	435 DAERTFunc fcn (dasrt_user_f);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	436
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	437 argp++;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	438
24217 2391bd89adf8 fix dasrt argument parsing for constraint function John W. Eaton <jwe@octave.org> parents: 24212 diff changeset	439 if (args(1).isempty () && args(1).is_double_type ())
2391bd89adf8 fix dasrt argument parsing for constraint function John W. Eaton <jwe@octave.org> parents: 24212 diff changeset	440 {
2391bd89adf8 fix dasrt argument parsing for constraint function John W. Eaton <jwe@octave.org> parents: 24212 diff changeset	441 // Allow [] to skip constraint function. This feature is
2391bd89adf8 fix dasrt argument parsing for constraint function John W. Eaton <jwe@octave.org> parents: 24212 diff changeset	442 // undocumented now, but was supported by earlier versions.
2391bd89adf8 fix dasrt argument parsing for constraint function John W. Eaton <jwe@octave.org> parents: 24212 diff changeset	443
2391bd89adf8 fix dasrt argument parsing for constraint function John W. Eaton <jwe@octave.org> parents: 24212 diff changeset	444 argp++;
2391bd89adf8 fix dasrt argument parsing for constraint function John W. Eaton <jwe@octave.org> parents: 24212 diff changeset	445 }
23700 d59fb809595b * dasrt.cc (Fdasrt): Use extract_function instead of is_valid_function. John W. Eaton <jwe@octave.org> parents: 23699 diff changeset	446 else
5729 e065f7c18bdc [project @ 2006-04-03 19:03:30 by jwe] jwe parents: 5694 diff changeset	447 {
26864 041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	448 if (args(1).is_function_handle () \|\| args(1).is_inline_function ()
041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	449 \|\| args(1).is_string ())
24217 2391bd89adf8 fix dasrt argument parsing for constraint function John W. Eaton <jwe@octave.org> parents: 24212 diff changeset	450 {
26864 041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	451 std::list<std::string> cf_param_names ({"x", "t"});
041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	452
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	453 dasrt_cf = get_function_handle (interp, args(1), cf_param_names);
24217 2391bd89adf8 fix dasrt argument parsing for constraint function John W. Eaton <jwe@octave.org> parents: 24212 diff changeset	454 }
2391bd89adf8 fix dasrt argument parsing for constraint function John W. Eaton <jwe@octave.org> parents: 24212 diff changeset	455
26864 041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	456 if (dasrt_cf.is_defined ())
24217 2391bd89adf8 fix dasrt argument parsing for constraint function John W. Eaton <jwe@octave.org> parents: 24212 diff changeset	457 {
2391bd89adf8 fix dasrt argument parsing for constraint function John W. Eaton <jwe@octave.org> parents: 24212 diff changeset	458 argp++;
2391bd89adf8 fix dasrt argument parsing for constraint function John W. Eaton <jwe@octave.org> parents: 24212 diff changeset	459
30896 c9788d7f6e65 maint: Use "fcn" as preferred abbreviation for "function" in libinterp/. Rik <rik@octave.org> parents: 30723 diff changeset	460 fcn.set_constraint_function (dasrt_user_cf);
24217 2391bd89adf8 fix dasrt argument parsing for constraint function John W. Eaton <jwe@octave.org> parents: 24212 diff changeset	461 }
5729 e065f7c18bdc [project @ 2006-04-03 19:03:30 by jwe] jwe parents: 5694 diff changeset	462 }
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	463
24217 2391bd89adf8 fix dasrt argument parsing for constraint function John W. Eaton <jwe@octave.org> parents: 24212 diff changeset	464 if (argp + 3 > nargin)
2391bd89adf8 fix dasrt argument parsing for constraint function John W. Eaton <jwe@octave.org> parents: 24212 diff changeset	465 print_usage ();
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	466
24205 affd98ae79ef correctly parse dasrt arguments John W. Eaton <jwe@octave.org> parents: 23219 diff changeset	467 ColumnVector state = args(argp++).xvector_value ("dasrt: initial state X_0 must be a vector");
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	468
24205 affd98ae79ef correctly parse dasrt arguments John W. Eaton <jwe@octave.org> parents: 23219 diff changeset	469 ColumnVector stateprime = args(argp++).xvector_value ("dasrt: initial derivatives XDOT_0 must be a vector");
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	470
24205 affd98ae79ef correctly parse dasrt arguments John W. Eaton <jwe@octave.org> parents: 23219 diff changeset	471 ColumnVector out_times = args(argp++).xvector_value ("dasrt: output time variable T must be a vector");
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	472
3994 a41827ec5677 [project @ 2002-07-16 23:57:09 by jwe] jwe parents: 3993 diff changeset	473 double tzero = out_times (0);
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	474
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	475 ColumnVector crit_times;
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	476
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	477 bool crit_times_set = false;
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	478
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	479 if (argp < nargin)
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	480 {
20711 7b608fadc663 Make error messages more specific about the variable and problem encountered. Rik <rik@octave.org> parents: 20703 diff changeset	481 crit_times = args(argp).xvector_value ("dasrt: list of critical times T_CRIT must be a vector");
20703 85e5efae848a eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20687 diff changeset	482 argp++;
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	483
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	484 crit_times_set = true;
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	485 }
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	486
26864 041caa61ed34 use get_function_handle instead of extract_function John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	487 if (dasrt_jac.is_defined ())
30896 c9788d7f6e65 maint: Use "fcn" as preferred abbreviation for "function" in libinterp/. Rik <rik@octave.org> parents: 30723 diff changeset	488 fcn.set_jacobian_function (dasrt_user_j);
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	489
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	490 DASRT_result output;
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	491
30896 c9788d7f6e65 maint: Use "fcn" as preferred abbreviation for "function" in libinterp/. Rik <rik@octave.org> parents: 30723 diff changeset	492 DASRT dae = DASRT (state, stateprime, tzero, fcn);
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	493
4122 19a1626b8d57 [project @ 2002-10-23 22:10:53 by jwe] jwe parents: 4117 diff changeset	494 dae.set_options (dasrt_opts);
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	495
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	496 if (crit_times_set)
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	497 output = dae.integrate (out_times, crit_times);
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	498 else
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	499 output = dae.integrate (out_times);
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	500
20557 b10432a40432 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20428 diff changeset	501 std::string msg = dae.error_message ();
3997 d4091aff6468 [project @ 2002-07-17 18:00:06 by jwe] jwe parents: 3994 diff changeset	502
20557 b10432a40432 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20428 diff changeset	503 if (dae.integration_ok ())
b10432a40432 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20428 diff changeset	504 {
20892 c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	505 retval(0) = output.state ();
20557 b10432a40432 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20428 diff changeset	506 retval(1) = output.deriv ();
20892 c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	507 retval(2) = output.times ();
20557 b10432a40432 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20428 diff changeset	508 }
b10432a40432 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20428 diff changeset	509 else
b10432a40432 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20428 diff changeset	510 {
b10432a40432 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20428 diff changeset	511 if (nargout < 4)
b10432a40432 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20428 diff changeset	512 error ("dasrt: %s", msg.c_str ());
20892 c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	513
c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	514 retval(0) = Matrix ();
c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	515 retval(1) = Matrix ();
c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	516 retval(2) = Matrix ();
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	517 }
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	518
20892 c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	519 retval(3) = static_cast<double> (dae.integration_state ());
c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	520 retval(4) = msg;
c07bee629973 2015 Code Sprint: use ovl (). Rik <rik@octave.org> parents: 20853 diff changeset	521
3990 46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	522 return retval;
46388d6a4e44 [project @ 2002-07-16 06:20:39 by jwe] jwe parents: diff changeset	523 }
29958 32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	524
32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	525 OCTAVE_NAMESPACE_END

Mercurial > octave

annotate libinterp/corefcn/dasrt.cc @ 30896:c9788d7f6e65