annotate scripts/signal/__parse_movargs__.m @ 27985:9f9ac219896d

maint: Remove remaining "Author:" instances from code base. * __ftp__.cc, load-save.cc, urlwrite.cc, xnorm.cc, xnorm.h, cconv2.f, cdotc3.f, cmatm3.f, csconv2.f, dconv2.f, ddot3.f, dmatm3.f, sconv2.f, sdot3.f, smatm3.f, zconv2.f, zdconv2.f, zdotc3.f, zmatm3.f, crsf2csf.f, zrsf2csf.f, oct-norm.cc, oct-norm.h, lin2mu.m, mu2lin.m, bincoeff.m, blkdiag.m, deal.m, gradient.m, interpft.m, nextpow2.m, postpad.m, prepad.m, repmat.m, shift.m, xor.m, griddata.m, rotx.m, roty.m, rotz.m, voronoin.m, getappdata.m, isappdata.m, rmappdata.m, setappdata.m, colormap.m, gray.m, gray2ind.m, im2double.m, image.m, imagesc.m, imread.m, imshow.m, ind2gray.m, ind2rgb.m, ocean.m, __imread__.m, rgb2ind.m, javachk.m, ClassHelper.java, usejava.m, findstr.m, commutation_matrix.m, cross.m, gls.m, housh.m, isdefinite.m, ishermitian.m, issymmetric.m, logm.m, null.m, ols.m, orth.m, qzhess.m, rref.m, dos.m, nargoutchk.m, orderfields.m, parseparams.m, __w2mpth__.m, unix.m, untar.m, unzip.m, expand_rel_paths.m, make_rel_paths.m, daspect.m, orient.m, pbaspect.m, rticks.m, thetaticks.m, xticklabels.m, xticks.m, yticklabels.m, yticks.m, zticklabels.m, zticks.m, comet.m, contourf.m, plot3.m, cla.m, copyobj.m, findfigs.m, hdl2struct.m, linkaxes.m, __ghostscript__.m, __gnuplot_get_var__.m, __gnuplot_has_feature__.m, __gnuplot_has_terminal__.m, __gnuplot_open_stream__.m, __gnuplot_print__.m, struct2hdl.m, subplot.m, compan.m, conv.m, deconv.m, mpoles.m, poly.m, polyder.m, polyfit.m, polyint.m, polyout.m, polyreduce.m, polyval.m, polyvalm.m, residue.m, roots.m, ismember.m, __parse_movargs__.m, detrend.m, fftconv.m, fftfilt.m, fftshift.m, filter2.m, movfun.m, movslice.m, ichol.m, pcg.m, beta.m, ellipke.m, lcm.m, nchoosek.m, pow2.m, primes.m, pascal.m, rosser.m, wilkinson.m, corr.m, kurtosis.m, skewness.m, base2dec.m, bin2dec.m, blanks.m, deblank.m, dec2base.m, dec2bin.m, dec2hex.m, hex2dec.m, index.m, rindex.m, strjoin.m, substr.m, untabify.m, calendar.m, datestr.m, eomday.m, now.m, weekday.m: Remove remaining "Author:" instances from code base.
author Rik <rik@octave.org>
date Tue, 21 Jan 2020 14:35:03 -0800
parents bdad8ca48700
children 601b6c7728ed 0a5b15007766
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
1 ########################################################################
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
2 ##
27919
1891570abac8 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 27918
diff changeset
3 ## Copyright (C) 2018-2020 The Octave Project Developers
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
4 ##
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
5 ## See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
6 ## distribution or <https://octave.org/copyright/>.
26244
58b3107a00bc Update documentation for movXXX functions (bug #48774).
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
7 ##
58b3107a00bc Update documentation for movXXX functions (bug #48774).
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
8 ## This file is part of Octave.
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 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
11 ## 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
12 ## 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
13 ## (at your option) any later version.
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 ## 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
16 ## 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
17 ## 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
18 ## 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
19 ##
58b3107a00bc Update documentation for movXXX functions (bug #48774).
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
20 ## 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
21 ## 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
22 ## <https://www.gnu.org/licenses/>.
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
23 ##
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
24 ########################################################################
26244
58b3107a00bc Update documentation for movXXX functions (bug #48774).
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
25
58b3107a00bc Update documentation for movXXX functions (bug #48774).
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
26 ## -*- texinfo -*-
58b3107a00bc Update documentation for movXXX functions (bug #48774).
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
27 ## @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
28 ##
58b3107a00bc Update documentation for movXXX functions (bug #48774).
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
29 ## 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
30 ##
58b3107a00bc Update documentation for movXXX functions (bug #48774).
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
31 ## @seealso{movfun}
58b3107a00bc Update documentation for movXXX functions (bug #48774).
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
32 ## @end deftypefn
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 function args = __parse_movargs__ (caller, varargin)
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
35
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
36 args = {};
26244
58b3107a00bc Update documentation for movXXX functions (bug #48774).
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
37
26247
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
38 have_dim = have_nancond = false;
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
39 imax = numel (varargin);
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
40 i = 1;
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
41 while (i <= imax)
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
42 arg = varargin{i};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
43 if (ischar (arg))
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
44 if (any (strcmpi (arg, {"omitnan", "includenan"})))
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
45 args(end+(1:2)) = {"nancond", arg};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
46 have_nancond = true;
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
47 else
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
48 i += 1; # Prop/Val pair
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
49 if (i > imax)
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
50 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
51 endif
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
52 args(end+(1:2)) = {arg, varargin{i}};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
53 endif
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
54 elseif (isnumeric (arg))
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
55 args(end+(1:2)) = {"dim", arg};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
56 have_dim = true;
26244
58b3107a00bc Update documentation for movXXX functions (bug #48774).
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
57 else
26247
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
58 error ("Octave:invalid-input-arg",
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
59 [caller ": invalid input at position %d"], i);
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
60 args(end+1) = arg;
26244
58b3107a00bc Update documentation for movXXX functions (bug #48774).
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
61 endif
26247
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
62
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
63 i += 1; # Advance to next element
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
64 if (have_nancond && have_dim)
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
65 args = [args, varargin(i:end)];
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
66 break;
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
67 endif
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
68 endwhile
26244
58b3107a00bc Update documentation for movXXX functions (bug #48774).
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
69
58b3107a00bc Update documentation for movXXX functions (bug #48774).
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
70 endfunction
58b3107a00bc Update documentation for movXXX functions (bug #48774).
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
71
58b3107a00bc Update documentation for movXXX functions (bug #48774).
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
72
26247
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
73 %!test
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
74 %! caller = "tstblock";
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
75 %! vararg = {5};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
76 %! assert (__parse_movargs__ (caller, vararg{:}), {"dim", 5});
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
77 %! vararg = {"Endpoints", "shrink", 3};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
78 %! assert (__parse_movargs__ (caller, vararg{:}),
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
79 %! {"Endpoints", "shrink", "dim", 3});
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
80 %! vararg = {"includenan", 2};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
81 %! assert (__parse_movargs__ (caller, vararg{:}),
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
82 %! {"nancond", "includenan", "dim", 2});
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
83
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
84 %!test
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
85 %! caller = "tstblock";
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
86 %! vararg = {"INCLUDENAN"};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
87 %! assert (__parse_movargs__ (caller, vararg{:}), {"nancond", "INCLUDENAN"});
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
88 %! vararg = {"Endpoints", "fill", "OMITNAN"};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
89 %! assert (__parse_movargs__ (caller, vararg{:}),
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
90 %! {"Endpoints", "fill", "nancond", "OMITNAN"});
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
91 %! vararg = {2, "includenan"};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
92 %! assert (__parse_movargs__ (caller, vararg{:}),
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
93 %! {"dim", 2, "nancond", "includenan"});
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
94
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
95 %!test
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
96 %! caller = "tstblock";
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
97 %! vararg = {};
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 %! vararg = {"Endpoints", "fill"};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
100 %! assert (__parse_movargs__ (caller, vararg{:}), {"Endpoints", "fill"});
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
101 %! vararg = {5, "omitnan", "Endpoints", "fill"};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
102 %! assert (__parse_movargs__ (caller, vararg{:}),
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
103 %! {"dim", 5, "nancond", "omitnan", "Endpoints", "fill"});