Mercurial > octave
view scripts/ode/private/check_default_input.m @ 30893:e1788b1a315f
maint: Use "fcn" as preferred abbreviation for "function" in m-files.
* accumarray.m, accumdim.m, quadl.m, quadv.m, randi.m, structfun.m,
__is_function__.m, uigetfile.m, uimenu.m, uiputfile.m, doc_cache_create.m,
colorspace_conversion_input_check.m, imageIO.m, argnames.m, vectorize.m,
vectorize.m, normest1.m, inputname.m, nthargout.m, display_info_file.m,
decic.m, ode15i.m, ode15s.m, ode23.m, ode23s.m, ode45.m, odeset.m,
check_default_input.m, integrate_adaptive.m, ode_event_handler.m,
runge_kutta_23.m, runge_kutta_23s.m, runge_kutta_45_dorpri.m,
runge_kutta_interpolate.m, starting_stepsize.m, __all_opts__.m, fminbnd.m,
fminsearch.m, fminunc.m, fsolve.m, fzero.m, sqp.m, fplot.m, plotyy.m,
__bar__.m, __ezplot__.m, flat_entry.html, profexport.m, movfun.m, bicg.m,
bicgstab.m, cgs.m, eigs.m, gmres.m, pcg.m, __alltohandles__.m, __sprand__.m,
qmr.m, tfqmr.m, dump_demos.m:
Replace "func", "fun", "fn" in documentation and variable names with "fcn".
author | Rik <rik@octave.org> |
---|---|
date | Mon, 04 Apr 2022 18:14:56 -0700 |
parents | 796f54d4ddbf |
children | c8ad083a5802 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2016-2022 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## This file is part of Octave. ## ## Octave is free software: you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation, either version 3 of the License, or ## (at your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <https://www.gnu.org/licenses/>. ## ######################################################################## function fcn = check_default_input (fcn, trange, solver, y0, yp0); if (nargin < 4) print_usage (); endif ## Check fcn validateattributes (fcn, {"function_handle", "char"}, {}, solver, "fcn"); if (! (nargin (fcn) == nargin - 2)) error ("Octave:invalid-input-arg", [solver ": invalid value assigned to field 'fcn'"]); endif if (ischar (fcn)) if (! exist (fcn)) error ("Octave:invalid-input-arg", [solver ": function '" fcn "' not found"]); endif fcn = str2func (fcn); endif if (! is_function_handle (fcn)) error ("Octave:invalid-input-arg", [solver ": invalid value assigned to field '" fcn "'"]); endif ## Check trange validateattributes (trange, {"float"}, {"vector", "real"}, solver, "trange"); if (numel (trange) < 2) error ("Octave:invalid-input-arg", [solver ": invalid value assigned to field 'trange'"]); elseif (! ((all (diff (trange) > 0)) || all (diff (-trange) > 0))) error ("Octave:invalid-input-arg", [solver ": invalid value assigned to field 'trange'"]); endif ## Check y0 and yp0 if (! isnumeric (y0) || ! isvector (y0)) error ("Octave:invalid-input-arg", [solver ": Y0 must be a numeric vector"]); endif y0 = y0(:); if (nargin == 5) if (! isnumeric (yp0) || ! isvector (yp0)) error ("Octave:invalid-input-arg", [solver ": YP0 must be a numeric vector"]); endif yp0 = yp0(:); n = numel (feval (fcn, trange(1), y0, yp0)); validateattributes (yp0, {"float"}, {"numel", n}, solver, "yp0"); else n = numel (feval (fcn, trange(1), y0)); endif validateattributes (y0, {"float"}, {"numel", n}, solver, "y0"); endfunction