octave: scripts/signal/__parse_movargs_

annotate scripts/signal/__parse_movargs__.m @ 26247:86217421a37f

__parse_movargs__.m: Accept dimension and nanflag arguments. * __parse_movargs__.m: Rewrite to accept both dimension and nanflag arguments as both may be present simultaneously. Create a new first argument to the function, caller, which is a string used in error messages so that the correct function is identified as the source of the error. Add BIST tests for function. * movmin.m: Call __parse_movargs__ with first argument of "movmin".

author	Rik <rik@octave.org>
date	Sun, 16 Dec 2018 13:53:54 -0800
parents	58b3107a00bc
children	00f796120a6d

rev	line source
26244 58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	1 ## Copyright (C) 2018 Juan Pablo Carbajal
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	2 ##
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	3 ## This file is part of Octave.
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	4 ##
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	5 ## Octave is free software: you can redistribute it and/or modify it
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	6 ## under the terms of the GNU General Public License as published by
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	7 ## the Free Software Foundation, either version 3 of the License, or
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	8 ## (at your option) any later version.
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	9 ##
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	13 ## GNU General Public License for more details.
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	14 ##
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	15 ## You should have received a copy of the GNU General Public License
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	16 ## along with Octave; see the file COPYING. If not, see
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	17 ## <https://www.gnu.org/licenses/>.
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	18
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	19 ## Author: Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	20 ## Created: 2018-08-13
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	21
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	22 ## -- texinfo --
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	23 ## @deftypefn {} {@var{args} =} __parse_movargs__ (@var{varargin})
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	24 ##
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	25 ## Parse arguments for movXXX functions before passing to @code{movfun}.
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	26 ##
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	27 ## @seealso{movfun}
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	28 ## @end deftypefn
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	29
26247 86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	30 function args = __parse_movargs__ (caller, varargin)
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	31
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	32 args = {};
26244 58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	33
26247 86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	34 have_dim = have_nancond = false;
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	35 imax = numel (varargin);
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	36 i = 1;
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	37 while (i <= imax)
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	38 arg = varargin{i};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	39 if (ischar (arg))
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	40 if (any (strcmpi (arg, {"omitnan", "includenan"})))
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	41 args(end+(1:2)) = {"nancond", arg};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	42 have_nancond = true;
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	43 else
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	44 i += 1; # Prop/Val pair
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	45 if (i > imax)
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	46 error ([caller ": property '%s' missing value argument"], arg);
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	47 endif
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	48 args(end+(1:2)) = {arg, varargin{i}};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	49 endif
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	50 elseif (isnumeric (arg))
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	51 args(end+(1:2)) = {"dim", arg};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	52 have_dim = true;
26244 58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	53 else
26247 86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	54 error ("Octave:invalid-input-arg",
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	55 [caller ": invalid input at position %d"], i);
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	56 args(end+1) = arg;
26244 58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	57 endif
26247 86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	58
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	59 i += 1; # Advance to next element
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	60 if (have_nancond && have_dim)
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	61 args = [args, varargin(i:end)];
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	62 break;
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	63 endif
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	64 endwhile
26244 58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	65
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	66 endfunction
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	67
58b3107a00bc Update documentation for movXXX functions (bug #48774). Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: diff changeset	68
26247 86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	69 %!test
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	70 %! caller = "tstblock";
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	71 %! vararg = {5};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	72 %! assert (__parse_movargs__ (caller, vararg{:}), {"dim", 5});
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	73 %! vararg = {"Endpoints", "shrink", 3};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	74 %! assert (__parse_movargs__ (caller, vararg{:}),
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	75 %! {"Endpoints", "shrink", "dim", 3});
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	76 %! vararg = {"includenan", 2};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	77 %! assert (__parse_movargs__ (caller, vararg{:}),
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	78 %! {"nancond", "includenan", "dim", 2});
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	79
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	80 %!test
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	81 %! caller = "tstblock";
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	82 %! vararg = {"INCLUDENAN"};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	83 %! assert (__parse_movargs__ (caller, vararg{:}), {"nancond", "INCLUDENAN"});
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	84 %! vararg = {"Endpoints", "fill", "OMITNAN"};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	85 %! assert (__parse_movargs__ (caller, vararg{:}),
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	86 %! {"Endpoints", "fill", "nancond", "OMITNAN"});
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	87 %! vararg = {2, "includenan"};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	88 %! assert (__parse_movargs__ (caller, vararg{:}),
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	89 %! {"dim", 2, "nancond", "includenan"});
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	90
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	91 %!test
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	92 %! caller = "tstblock";
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	93 %! vararg = {};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	94 %! assert (__parse_movargs__ (caller, vararg{:}), {});
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	95 %! vararg = {"Endpoints", "fill"};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	96 %! assert (__parse_movargs__ (caller, vararg{:}), {"Endpoints", "fill"});
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	97 %! vararg = {5, "omitnan", "Endpoints", "fill"};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	98 %! assert (__parse_movargs__ (caller, vararg{:}),
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments. Rik <rik@octave.org> parents: 26244 diff changeset	99 %! {"dim", 5, "nancond", "omitnan", "Endpoints", "fill"});

Mercurial > octave

annotate scripts/signal/__parse_movargs__.m @ 26247:86217421a37f