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

annotate scripts/ode/odeget.m @ 20580:25623ef2ff4f

doc: Rewrite docstrings for ode* family of functions. * scripts/ode/module.mk: Remove extra newline. * ode45.m, odeget.m, odeset.m: Rewrite docstrings. * AbsRel_Norm.m, fuzzy_compare.m, hermite_quartic_interpolation.m, integrate_adaptive.m, integrate_const.m, integrate_n_steps.m, kahan.m, ode_struct_value_check.m, odepkg_event_handle.m, odepkg_structure_check.m, runge_kutta_45_dorpri.m, starting_stepsize.m: Don't break @deftypefn lines. Wrap lines at 80 columns rather than 72.

author	Rik <rik@octave.org>
date	Sat, 03 Oct 2015 21:03:16 -0700
parents	fcb792acab9b
children	e368ce72a844

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} {@var{option} =} odeget (@var{ode_opt}, @var{field})
25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	22 ## @deftypefnx {Function File} {@var{option} =} odeget (@var{ode_opt}, @var{field}, @var{default})
25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	23 ##
25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	24 ## Query the value of the property @var{field} in the ODE options structure
25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	25 ## @var{ode_opt}.
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	26 ##
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	27 ## If this function is called with two input arguments and the first input
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	28 ## argument @var{ode_opt} is of type structure array and the second input
20580 25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	29 ## argument @var{field} is of type string then return the option value
25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	30 ## @var{res} that is specified by the option name @var{field} in the ODE
25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	31 ## option structure @var{ode_opt}. Optionally if this function is called
25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	32 ## with a third input argument then return the default value @var{default} if
25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	33 ## @var{field} is not set in the structure @var{ode_opt}.
25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	34 ## @seealso{odeset}
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	35 ## @end deftypefn
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	36
20580 25623ef2ff4f doc: Rewrite docstrings for ode* family of functions. Rik <rik@octave.org> parents: 20568 diff changeset	37 ## Note: 2006-10-22, Thomas Treichl
20568 fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	38 ## We cannot create a function of the form odeget (@var{odestruct},
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	39 ## @var{name1}, @var{name2}) because we would get a mismatch with
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	40 ## the function form 1 like described above.
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	41
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	42 function res = odeget (ode_opt, field, default, opt)
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	43
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	44 ## Check number and types of input arguments
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	45 if (nargin == 1)
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	46 error ("OdePkg:InvalidArgument",
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	47 "input arguments number must be at least 2")
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	48 endif
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	49
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	50 if (isempty (ode_opt))
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	51 if (nargin == 2)
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	52 res = [];
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	53 return
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	54 endif
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	55 res = default;
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	56 return
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	57 endif
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	58
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	59 if (! isstruct (ode_opt))
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	60 error ("OdePkg:InvalidArgument",
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	61 "first input argument must be a valid ODE_STRUCT.");
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	62 endif
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	63
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	64 if (! ischar (field))
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	65 error ("OdePkg:InvalidArgument",
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	66 "second input argument must be a string.");
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	67 endif
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	68
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	69 if (nargin == 2)
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	70 default = [];
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	71 endif
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 if ((nargin == 4)
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	74 && strcmp (lower (deblank (opt)), "fast"))
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	75 if (isfield (ode_opt, field))
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	76 res = ode_opt.(field);
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	77 else
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	78 res = default;
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	79 endif
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	80 return
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
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	83 if ((nargin == 4)
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	84 && strcmp (lower (deblank (opt)), "fast_not_empty"))
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	85 if (isfield (ode_opt, field)
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	86 && ! isempty (ode_opt.(field)) )
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	87 res = ode_opt.(field);
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	88 else
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	89 res = default;
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	90 endif
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	91 return
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	92 endif
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	93
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	94 ## check if the given struct is a valid OdePkg struct
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	95 ode_struct_value_check (ode_opt);
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	96
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	97 ## define all the possible OdePkg fields
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	98 options = ["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	99 "Explicit"; "InexactSolver"; "InitialSlope"; "InitialStep";
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	100 "Jacobian";"JConstant";"JPattern";"Mass"; "MassConstant";
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	101 "MassSingular"; "MaxNewtonIterations"; "MaxOrder"; "MaxStep";
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	102 "MStateDependence"; "MvPattern"; "NewtonTol"; "NonNegative";
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	103 "NormControl"; "OutputFcn"; "OutputSave"; "OutputSel";
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	104 "PolynomialDegree"; "QuadratureOrder"; "Refine"; "RelTol";
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	105 "Restart"; "Stats"; "TimeStepNumber"; "TimeStepSize";
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	106 "UseJacobian"; "Vectorized"];
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	107
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	108 while (1)
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	109 pos = fuzzy_compare (field, options);
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	110
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	111 if (size (pos, 1) == 0) # no matching for the given option
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	112 if (nargin == 2)
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	113 error ("OdePkg:InvalidArgument",
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	114 "invalid property. No property found with name ''%s''.", field);
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	115 endif
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	116 warning ("odeget:NoExactMatching",
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	117 "no property found with name ''%s''. ",
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	118 "Assuming default value.", field);
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	119 res = default;
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	120 return
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	121 endif
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	122
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	123 if (size (pos, 1) == 1) # one matching
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	124 if (! strcmp (lower (deblank (field)),
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	125 lower (deblank (options(pos,:)))) )
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	126 warning ("OdePkg:InvalidArgument",
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	127 "no exact matching for ''%s''. ",
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	128 "Assuming you was intending ''%s''.",
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	129 field, deblank (options(pos,:)));
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	130 endif
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	131 res = ode_opt.(deblank (options(pos,:)));
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	132 if (isempty (res))
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	133 res = default;
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	134 return
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	135 endif
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	136 return
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	137 endif
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	138
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	139 ## 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	140 warning ("OdePkg:InvalidArgument", ...
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	141 "no exact matching for ''%s''. %d possible fields were found.",
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	142 field, size (pos, 1));
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	143 for j = 1:(size (pos, 1))
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	144 fprintf ("%s\n", deblank (options(pos(j),:)));
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	145 endfor
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	146 do
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	147 fprintf ("Please insert field name again.\n");
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	148 field = input ("New field name: ");
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	149 until (ischar (field))
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	150 endwhile
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	151
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	152 endfunction
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	153
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	154 %! ## Turn off output of warning messages for all tests, turn them on
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	155 %! ## again if the last test is called
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	156 %! warning ('off', 'OdePkg:InvalidArgument');
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	157 %!test assert (odeget (odeset (), 'RelTol'), []);
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	158 %!test assert (odeget (odeset (), 'RelTol', 10), 10);
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	159 %!test assert (odeget (odeset (), 'Stats'), []);
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	160 %!test assert (odeget (odeset (), 'Stats', 'on'), 'on');
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	161 %!test assert (odeget (odeset (), 'AbsTol', 1.e-6, 'fast'), []);
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	162 %!test assert (odeget (odeset (), 'AbsTol', 1.e-6, 'fast_not_empty'), 1.e-6);
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	163 %!test assert (odeget (odeset (), 'AbsTol', 1e-9), 1e-9);
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	164 %!
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	165 %! warning ('on', 'OdePkg:InvalidArgument');
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	166
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	167 %!demo
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	168 %! # Return the manually changed value RelTol of the OdePkg options
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	169 %! # strutcure A. If RelTol wouldn't have been changed then an
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	170 %! # empty matrix value would have been returned.
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	171 %!
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	172 %! A = odeset ('RelTol', 1e-1, 'AbsTol', 1e-2);
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	173 %! odeget (A, 'RelTol', [])
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	174
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	175 ## Local Variables: ***
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	176 ## mode: octave ***
fcb792acab9b Moving ode45, odeset, odeget, and levenshtein from odepkg to core. jcorno <jacopo.corno@gmail.com> parents: diff changeset	177 ## End: ***

Mercurial > octave-nkf

annotate scripts/ode/odeget.m @ 20580:25623ef2ff4f