octave-nkf: scripts/ode/odeset.m annotate

annotate scripts/ode/odeset.m @ 20585:45151de7423f

maint: Clean up implementations of ode45.m, odeget.m, odeset.m. * ode45.m: Match variable names in function to docstring. Don't use '...' line continuation unless strictly necessary. Remove incorrect isa check for inline function. Use '( )' around switch statement test variable. Use printf, rather than fprintf, where possible. * odeget.m: Match variable names in function to docstring. Rephrase error messages to begin with 'odeget:'. Use try/catch blocks to speed up "fast" and "fast_not_empty" code. Use rows() rather than "size (xxx, 1)". Use isempty rather than "size (xxx, 1) == 0". Use printf, rather than fprintf, where possible. Use unwind_protect block in BIST tests to restore warning state. * odeset.m: Match variable names in function to docstring. Use rows() rather than "size (xxx, 1)". Use isempty rather than "size (xxx, 1) == 0". Use printf, rather than fprintf, where possible. Eliminate for loop with cell2struct for odestruct initialization. Introduce temporary vars oldstruct, newstruct to clarify code. Restate some error messages to begin with 'odeset:'. Use cellfun to quickl check that all field inputs are strings. Use unwind_protect block in BIST tests to restore warning state.

author	Rik <rik@octave.org>
date	Mon, 05 Oct 2015 11:59:18 -0700
parents	e368ce72a844
children	e5f36a7854a5

rev	line source
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	1 ## Copyright (C) 2013, Roberto Porcu' <roberto.porcu@polimi.it>
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	2 ## Copyright (C) 2006-2012, Thomas Treichl <treichl@users.sourceforge.net>
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	3 ##
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	4 ## This file is part of Octave.
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	5 ##
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	6 ## Octave is free software; you can redistribute it and/or modify it
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	7 ## under the terms of the GNU General Public License as published by
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	8 ## the Free Software Foundation; either version 3 of the License, or (at
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	9 ## your option) any later version.
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	10 ##
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	11 ## Octave is distributed in the hope that it will be useful, but
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	14 ## General Public License for more details.
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	15 ##
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	16 ## You should have received a copy of the GNU General Public License
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	17 ## along with Octave; see the file COPYING. If not, see
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	18 ## <http://www.gnu.org/licenses/>.
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	19
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	20 ## -- texinfo --
20580 25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	21 ## @deftypefn {Function File} {} odeset ()
25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	22 ## @deftypefnx {Function File} {@var{odestruct} =} odeset (@var{"field1"}, @var{value1}, @var{"field2"}, @var{value2}, @dots{})
25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	23 ## @deftypefnx {Function File} {@var{odestruct} =} odeset (@var{oldstruct}, @var{"field1"}, @var{value1}, @var{"field2"}, @var{value2}, @dots{})
25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	24 ## @deftypefnx {Function File} {@var{odestruct} =} odeset (@var{oldstruct}, @var{newstruct})
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	25 ##
20580 25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	26 ## Create or modify an ODE options structure.
25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	27 ##
25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	28 ## If this function is called without an input argument then return a new ODE
25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	29 ## options structure array that contains all the necessary fields and sets
25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	30 ## the values of all fields to default values.
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	31 ##
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	32 ## If this function is called with string input arguments @var{"field1"},
20580 25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	33 ## @var{"field2"}, @dots{} identifying valid ODE options then return a new
25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	34 ## ODE options structure with all necessary fields and set the values of the
25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	35 ## fields @var{"field1"}, @var{"field2"}, @dots{} to the values @var{value1},
25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	36 ## @var{value2}, @dots{}
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	37 ##
20580 25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	38 ## If this function is called with a first input argument @var{oldstruct} of
25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	39 ## type structure array then overwrite all values of the options
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	40 ## @var{"field1"}, @var{"field2"}, @dots{} of the structure @var{oldstruct}
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	41 ## with new values @var{value1}, @var{value2}, @dots{} and return the
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	42 ## modified structure array.
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	43 ##
20580 25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	44 ## If this function is called with two input arguments @var{oldstruct} and
25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	45 ## @var{newstruct} of type structure array then overwrite all values in the
25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	46 ## fields from the structure @var{oldstruct} with new values of the fields
25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	47 ## from the structure @var{newstruct}. Empty values of @var{newstruct} will
25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	48 ## not overwrite values in @var{oldstruct}.
25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	49 ## @seealso{odeget}
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	50 ## @end deftypefn
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	51
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	52 function odestruct = odeset (varargin)
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	53
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	54 ## Special calling syntax to display defaults
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	55 if (nargin == 0 && nargout == 0)
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	56 print_options ();
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	57 return;
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	58 endif
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	59
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	60 ## Column vector of all possible OdePkg fields
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	61 fields = ["AbsTol"; "Algorithm"; "BDF"; "Choice"; "Eta"; "Events";
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	62 "Explicit"; "InexactSolver"; "InitialSlope"; "InitialStep";
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	63 "Jacobian";"JConstant";"JPattern";"Mass"; "MassConstant";
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	64 "MassSingular"; "MaxNewtonIterations"; "MaxOrder"; "MaxStep";
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	65 "MStateDependence"; "MvPattern"; "NewtonTol"; "NonNegative";
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	66 "NormControl"; "OutputFcn"; "OutputSave"; "OutputSel";
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	67 "PolynomialDegree"; "QuadratureOrder"; "Refine"; "RelTol";
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	68 "Restart"; "Stats"; "TimeStepNumber"; "TimeStepSize";
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	69 "UseJacobian"; "Vectorized"];
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	70
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	71 fields_nb = rows (fields);
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	72
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	73 ## initialize output
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	74 odestruct = cell2struct (cell (rows (fields), 1), cellstr (fields));
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	75
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	76 odestruct.Refine = 0;
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	77 odestruct.OutputSave = 1;
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	78
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	79 if (nargin == 0 && nargout == 1)
e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	80 return;
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	81 endif
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	82
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	83 ode_fields = fieldnames (odestruct);
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	84
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	85 if (isstruct (varargin{1}))
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	86 oldstruct = varargin{1};
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	87 ode_struct_value_check (oldstruct);
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	88
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	89 optA_fields = fieldnames (oldstruct);
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	90 optA_f_nb = length (optA_fields);
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	91
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	92 ## loop on first struct options for updating
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	93 for i = 1:optA_f_nb
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	94 name = lower (deblank (optA_fields{i}));
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	95
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	96 while (1)
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	97 pos = fuzzy_compare (name, fields);
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	98 if (isempty (pos))
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	99 warning ("OdePkg:InvalidArgument",
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	100 "no property found with name '%s'", name);
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	101 endif
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	102
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	103 if (rows (pos) == 1)
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	104 if (! strcmp (lower (deblank (name)),
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	105 lower (deblank (fields(pos,:)))))
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	106 warning ("OdePkg:InvalidArgument", "no exact matching for ",
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	107 "'%s'. Assuming you were intending '%s'",
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	108 name, deblank (fields(pos,:)));
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	109 endif
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	110
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	111 odestruct.(deblank (fields(pos,:))) = oldstruct.(optA_fields{i});
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	112 break;
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	113 endif
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	114
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	115 ## FIXME: Do we really need interactive selection?
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	116 ## if there are more matching, ask the user to be more precise
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	117 warning ("OdePkg:InvalidArgument",
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	118 "no exact matching for '%s'. %d possible fields were found",
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	119 name, size(pos, 1));
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	120 for j = 1:(rows (pos))
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	121 printf ("%s\n", deblank (fields(pos(j),:)));
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	122 endfor
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	123 do
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	124 disp ("Please insert field name again");
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	125 name = input ("New field name: ");
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	126 until (ischar (name))
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	127 endwhile
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	128 endfor
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	129
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	130 if (nargin == 2 && isstruct (varargin{2}))
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	131 newstruct = varargin{2};
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	132 ode_struct_value_check (newstruct);
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	133
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	134 optB_fields = fieldnames (newstruct);
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	135 optB_f_nb = length (optB_fields);
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	136
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	137 ## update the first struct with the values in the second one
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	138 for i = 1:optB_f_nb
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	139 name = lower (deblank (optB_fields{i}));
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	140 while (1)
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	141 pos = fuzzy_compare (name, fields);
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	142
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	143 if (isempty (pos))
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	144 warning ("OdePkg:InvalidArgument",
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	145 "no property found with name '%s'", name);
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	146 endif
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	147
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	148 if (rows (pos) == 1)
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	149 if (! strcmp (lower (deblank (name)),
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	150 lower (deblank (fields(pos,:)))))
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	151 warning ("OdePkg:InvalidArgument", "no exact matching for ",
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	152 "'%s'. Assuming you were intending '%s'",
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	153 name, deblank (fields(pos,:)));
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	154 endif
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	155 odestruct.(deblank (fields(pos,:))) = newstruct.(optB_fields{i});
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	156 break;
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	157 endif
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	158
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	159 ## FIXME: Do we really need interactive selection?
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	160 ## if there are more matching, ask the user to be more precise
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	161 warning ("OdePkg:InvalidArgument", "no exact matching for '%s'. ",
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	162 "%d possible fields were found",
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	163 name, rows (pos));
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	164 for j = 1:(rows (pos))
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	165 printf ("%s\n", deblank (fields(pos(j),:)));
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	166 endfor
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	167 do
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	168 disp ("Please insert field name again");
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	169 name = input ("New field name: ");
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	170 until (ischar (name))
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	171 endwhile
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	172 endfor
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	173 return;
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	174 endif
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	175
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	176 ## if the second argument is not a struct,
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	177 ## pass new values of the OdePkg options to the first struct
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	178 if (mod (nargin, 2) != 1)
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	179 error ("odeset: FIELD/VALUE arguments must occur in pairs");
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	180 endif
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	181
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	182 if (! all (cellfun ("isclass", varargin(2:2:end), "char")))
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	183 error ("odeset: All FIELD names must be strings");
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	184 endif
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	185
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	186 ## loop on the input arguments
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	187 for i = 2:2:(nargin - 1)
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	188 name = varargin{i};
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	189
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	190 while (1)
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	191 pos = fuzzy_compare (name, fields);
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	192
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	193 if (isempty (pos))
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	194 error ("OdePkg:InvalidArgument",
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	195 "no property found with name '%s'", name);
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	196 endif
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	197
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	198 if (rows (pos) == 1)
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	199 if (! strcmp (lower (deblank (name)),
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	200 lower (deblank (fields(pos,:)))))
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	201 warning ("OdePkg:InvalidArgument", "no exact matching for '%s'. ",
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	202 "%d possible fields were found",
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	203 name, rows (pos));
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	204 endif
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	205 odestruct.(deblank (fields(pos,:))) = varargin{i+1};
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	206 break;
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	207 endif
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	208
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	209 ## FIXME: Do we really need interactive selection?
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	210 ## if there are more matching, ask the user to be more precise
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	211 warning ("OdePkg:InvalidArgument", "no exact matching for '%s'. ",
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	212 "%d possible fields were found",
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	213 name, rows (pos));
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	214 for j = 1:(rows (pos))
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	215 printf ("%s\n", deblank (fields(pos(j),:)));
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	216 endfor
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	217 do
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	218 disp ("Please insert field name again");
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	219 name = input ("New field name: ");
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	220 until (ischar (name))
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	221 endwhile
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	222 endfor
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	223
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	224 ## check if all has been done gives a valid OdePkg struct
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	225 ode_struct_value_check (odestruct);
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	226 return;
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	227 endif
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	228
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	229 ## first input argument was not a struct
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	230 if (mod (nargin, 2) != 0)
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	231 error ("odeset: FIELD/VALUE arguments must occur in pairs");
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	232 endif
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	233
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	234 if (! all (cellfun ("isclass", varargin(1:2:end), "char")))
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	235 error ("odeset: All FIELD names must be strings");
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	236 endif
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	237
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	238 for i = 1:2:(nargin-1)
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	239 name = varargin{i};
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	240
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	241 while (1)
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	242 pos = fuzzy_compare (name, fields);
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	243
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	244 if (isempty (pos))
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	245 error ("OdePkg:InvalidArgument",
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	246 "invalid property. No property found with name '%s'", name);
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	247 endif
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	248
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	249 if (rows (pos) == 1)
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	250 if (! strcmp (lower (deblank (name)),
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	251 lower (deblank (fields(pos,:)))))
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	252 warning ("OdePkg:InvalidArgument", "no exact matching for ",
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	253 "'%s'. Assuming you were intending '%s'",
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	254 name, deblank (fields(pos,:)));
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	255 endif
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	256 odestruct.(deblank (fields(pos,:))) = varargin{i+1};
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	257 break;
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	258 endif
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	259
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	260 ## FIXME: Do we really need interactive selection?
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	261 ## if there are more matching, ask the user to be more precise
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	262 warning ("OdePkg:InvalidArgument", "no exact matching for '%s'. ",
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	263 "%d possible fields were found",
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	264 name, rows (pos));
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	265 for j = 1:rows (pos)
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	266 printf ("%s\n", deblank (fields(pos(j),:)));
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	267 endfor
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	268 do
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	269 disp ("Please insert field name again");
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	270 name = input ("New field name: ");
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	271 until (ischar (name))
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	272 endwhile
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	273 endfor
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	274
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	275 ## check if all has been done gives a valid OdePkg struct
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	276 ode_struct_value_check (odestruct);
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	277
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	278 endfunction
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	279
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	280 ## function useful to print all the possible options
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	281 function print_options ()
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	282
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	283 disp ("These following are all possible options.");
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	284 disp ("Default values are put in square brackets.");
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	285 disp ("");
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	286 disp (" AbsTol: scalar or vector, >0, [1e-6]");
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	287 disp (" Algorithm: string, {['gmres'], 'pcg', 'bicgstab'}");
e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	288 disp (" BDF: binary, {'on', ['off']}");
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	289 disp (" Choice: switch, {[1], 2}");
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	290 disp (" Eta: scalar, >=0, <1, [0.5]");
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	291 disp (" Events: function_handle, []");
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	292 disp (" Explicit: binary, {'yes', ['no']}");
e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	293 disp (" InexactSolver: string, {'inexact_newton', 'fsolve', []}");
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	294 disp (" InitialSlope: vector, []");
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	295 disp (" InitialStep: scalar, >0, []");
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	296 disp (" Jacobian: matrix or function_handle, []");
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	297 disp (" JConstant: binary, {'on', ['off']}");
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	298 disp (" JPattern: sparse matrix, []");
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	299 disp (" Mass: matrix or function_handle, []");
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	300 disp (" MassConstant: binary, {'on', ['off']}");
e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	301 disp (" MassSingular: switch, {'yes', ['maybe'], 'no'}");
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	302 disp ("MaxNewtonIterations: scalar, integer, >0, [1e3]");
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	303 disp (" MaxOrder: switch, {1, 2, 3, 4, [5]}");
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	304 disp (" MaxStep: scalar, >0, []");
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	305 disp (" MStateDependence: switch, {'none', ['weak'], 'strong'}");
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	306 disp (" MvPattern: sparse matrix, []");
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	307 disp (" NewtonTol: scalar or vector, >0, []");
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	308 disp (" NonNegative: vector of integers, []");
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	309 disp (" NormControl: binary, {'on', ['off']}");
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	310 disp (" OutputFcn: function_handle, []");
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	311 disp (" OutputSave: scalar, integer, >0, []");
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	312 disp (" OutputSel: scalar or vector, []");
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	313 disp (" PolynomialDegree: scalar, integer, >0, []");
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	314 disp (" QuadratureOrder: scalar, integer, >0, []");
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	315 disp (" Refine: scalar, integer, >0, []");
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	316 disp (" RelTol: scalar, >0, [1e-3]");
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	317 disp (" Restart: scalar, integer, >0, [20]");
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	318 disp (" Stats: binary, {'on', ['off']}");
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	319 disp (" TimeStepNumber: scalar, integer, >0, []");
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	320 disp (" TimeStepSize: scalar, >0, []");
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	321 disp (" UseJacobian: binary, {'yes', ['no']}");
e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	322 disp (" Vectorized: binary, {'on', ['off']}");
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	323
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	324 endfunction
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	325
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	326
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	327 %!demo
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	328 %! # A new OdePkg options structure with default values is created.
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	329 %!
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	330 %! odeoptA = odeset ();
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	331
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	332 %!demo
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	333 %! # A new OdePkg options structure with manually set options
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	334 %! # for "AbsTol" and "RelTol" is created.
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	335 %!
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	336 %! odeoptB = odeset ("AbsTol", 1e-2, "RelTol", 1e-1);
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	337
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	338 %!demo
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	339 %! # A new OdePkg options structure is created from odeoptB with
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	340 %! # a modified value for option "NormControl".
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	341
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	342 %! odeoptB = odeset ("AbsTol", 1e-2, "RelTol", 1e-1);
e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	343 %! odeoptC = odeset (odeoptB, "NormControl", "on");
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	344
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	345 ## All tests that are needed to check if a correct resp. valid option
e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	346 ## has been set are implemented in ode_struct_value_check.m.
20585 45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	347 %!test
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	348 %! wstate = warning ("off", "OdePkg:InvalidArgument");
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	349 %! unwind_protect
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	350 %! odeoptA = odeset ();
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	351 %! ## FIXME: no assert check on odeoptA
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	352 %! odeoptB = odeset ("AbsTol", 1e-2, "RelTol", 1e-1);
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	353 %! assert (odeoptB.AbsTol, 1e-2);
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	354 %! assert (odeoptB.RelTol, 1e-1);
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	355 %! odeoptC = odeset (odeoptB, "NormControl", "on");
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	356 %! ## FIXME: no assert check on odeoptC
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	357 %! odeoptD = odeset (odeoptC, odeoptB);
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	358 %! ## FIXME: no assert check on odeoptD
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	359 %! unwind_protect_cleanup
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	360 %! warning (wstate);
45151de7423f maint: Clean up implementations of ode45.m, odeget.m, odeset.m. Rik <rik@octave.org> parents: 20581 diff changeset	361 %! end_unwind_protect
20581 e368ce72a844 maint: Use Octave coding conventions for ode* functions. Rik <rik@octave.org> parents: 20580 diff changeset	362

Mercurial > octave-nkf

annotate scripts/ode/odeset.m @ 20585:45151de7423f