Mercurial > octave

annotate scripts/signal/__parse_movargs__.m @ 28920:601b6c7728ed

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: match names in documentation to input parameters in function. * rotx.m, roty.m, rotz.m: Reformat documentation to 80 columns. Rename output to "T". Rename input to "angle". Re-use angle variable and delete "angle_in_rad" variable. * computer.m: Rename input "a" to "arch". * default_prefix.m: Add second input "desc" to Texinfo documentation. Add FIXME as second input appears unused. * camlookat.m: Remove extra blank line in documentation. * __line__.m: Rename input "parent" to "hp" in documentation. * __plt__.m: Rename input "hparent" to "hp" in documentation. * __add_default_menu__.m: Add input "htb" to documentation. Rename input "hfig" to "hf" in documentation. Briefly document all three inputs. * __parse_movargs__.m: Add input "caller" to documentation. Document caller input.
author Rik <rik@octave.org>
date Tue, 13 Oct 2020 23:19:09 -0700
parents 9f9ac219896d
children c2db7bd05c00
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 -*-
28920
601b6c7728ed maint: match names in documentation to input parameters in function.
Rik <rik@octave.org>
parents: 27985
diff changeset
27 ## @deftypefn {} {@var{args} =} __parse_movargs__ (@var{caller}, @var{varargin})
26244
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 ##
28920
601b6c7728ed maint: match names in documentation to input parameters in function.
Rik <rik@octave.org>
parents: 27985
diff changeset
31 ## The input @var{caller} is a string with the name of the calling function
601b6c7728ed maint: match names in documentation to input parameters in function.
Rik <rik@octave.org>
parents: 27985
diff changeset
32 ## and is used to personalize any error messages.
26244
58b3107a00bc Update documentation for movXXX functions (bug #48774).
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
33 ## @seealso{movfun}
58b3107a00bc Update documentation for movXXX functions (bug #48774).
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
34 ## @end deftypefn
58b3107a00bc Update documentation for movXXX functions (bug #48774).
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
35
26247
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
36 function args = __parse_movargs__ (caller, varargin)
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
37
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
38 args = {};
26244
58b3107a00bc Update documentation for movXXX functions (bug #48774).
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
39
26247
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
40 have_dim = have_nancond = false;
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
41 imax = numel (varargin);
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
42 i = 1;
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
43 while (i <= imax)
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
44 arg = varargin{i};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
45 if (ischar (arg))
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
46 if (any (strcmpi (arg, {"omitnan", "includenan"})))
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
47 args(end+(1:2)) = {"nancond", arg};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
48 have_nancond = true;
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
49 else
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
50 i += 1; # Prop/Val pair
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
51 if (i > imax)
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
52 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
53 endif
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
54 args(end+(1:2)) = {arg, varargin{i}};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
55 endif
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
56 elseif (isnumeric (arg))
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
57 args(end+(1:2)) = {"dim", arg};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
58 have_dim = true;
26244
58b3107a00bc Update documentation for movXXX functions (bug #48774).
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
59 else
26247
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
60 error ("Octave:invalid-input-arg",
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
61 [caller ": invalid input at position %d"], i);
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
62 args(end+1) = arg;
26244
58b3107a00bc Update documentation for movXXX functions (bug #48774).
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
63 endif
26247
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
64
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
65 i += 1; # Advance to next element
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
66 if (have_nancond && have_dim)
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
67 args = [args, varargin(i:end)];
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
68 break;
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
69 endif
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
70 endwhile
26244
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 endfunction
58b3107a00bc Update documentation for movXXX functions (bug #48774).
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
73
58b3107a00bc Update documentation for movXXX functions (bug #48774).
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
74
26247
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
75 %!test
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
76 %! caller = "tstblock";
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
77 %! vararg = {5};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
78 %! assert (__parse_movargs__ (caller, vararg{:}), {"dim", 5});
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
79 %! vararg = {"Endpoints", "shrink", 3};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
80 %! assert (__parse_movargs__ (caller, vararg{:}),
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
81 %! {"Endpoints", "shrink", "dim", 3});
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
82 %! vararg = {"includenan", 2};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
83 %! assert (__parse_movargs__ (caller, vararg{:}),
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
84 %! {"nancond", "includenan", "dim", 2});
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
85
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
86 %!test
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
87 %! caller = "tstblock";
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
88 %! vararg = {"INCLUDENAN"};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
89 %! assert (__parse_movargs__ (caller, vararg{:}), {"nancond", "INCLUDENAN"});
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
90 %! vararg = {"Endpoints", "fill", "OMITNAN"};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
91 %! assert (__parse_movargs__ (caller, vararg{:}),
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
92 %! {"Endpoints", "fill", "nancond", "OMITNAN"});
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
93 %! vararg = {2, "includenan"};
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 %! {"dim", 2, "nancond", "includenan"});
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
96
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
97 %!test
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
98 %! caller = "tstblock";
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
99 %! vararg = {};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
100 %! assert (__parse_movargs__ (caller, vararg{:}), {});
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
101 %! vararg = {"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{:}), {"Endpoints", "fill"});
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
103 %! vararg = {5, "omitnan", "Endpoints", "fill"};
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
104 %! assert (__parse_movargs__ (caller, vararg{:}),
86217421a37f __parse_movargs__.m: Accept dimension and nanflag arguments.
Rik <rik@octave.org>
parents: 26244
diff changeset
105 %! {"dim", 5, "nancond", "omitnan", "Endpoints", "fill"});