octave-nkf: scripts/general/nargchk.m annotate

annotate scripts/general/nargchk.m @ 10793:be55736a0783

Grammarcheck the documentation from m-files.

author	Rik <octave@nomad.inbox5.com>
date	Sun, 18 Jul 2010 20:35:16 -0700
parents	1f47a9404d93
children	eb9e0b597d61

rev	line source
8920 eb63fbe60fab update copyright notices John W. Eaton <jwe@octave.org> parents: 8664 diff changeset	1 ## Copyright (C) 2008, 2009 Bill Denney
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	6 ## under the terms of the GNU General Public License as published by
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6046 diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6046 diff changeset	8 ## your option) any later version.
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	15 ## You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6046 diff changeset	16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6046 diff changeset	17 ## <http://www.gnu.org/licenses/>.
710 60af453e3f67 [project @ 1994-09-17 14:29:26 by jwe] jwe parents: diff changeset	18
3371 86873384cd10 [project @ 1999-11-21 17:31:07 by jwe] jwe parents: 2847 diff changeset	19 ## -- texinfo --
10793 be55736a0783 Grammarcheck the documentation from m-files. Rik <octave@nomad.inbox5.com> parents: 9204 diff changeset	20 ## @deftypefn {Function File} {@var{msgstr} =} nargchk (@var{minargs}, @var{maxargs}, @var{nargs})
8522 d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	21 ## @deftypefnx {Function File} {@var{msgstr} =} nargchk (@var{minargs}, @var{maxargs}, @var{nargs}, "string")
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	22 ## @deftypefnx {Function File} {@var{msgstruct} =} nargchk (@var{minargs}, @var{maxargs}, @var{nargs}, "struct")
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	23 ## Return an appropriate error message string (or structure) if the
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	24 ## number of inputs requested is invalid.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3371 diff changeset	25 ##
8522 d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	26 ## This is useful for checking to see that the number of input arguments
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	27 ## supplied to a function is within an acceptable range.
7658 1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions bill@denney.ws parents: 7017 diff changeset	28 ## @seealso{nargoutchk, error, nargin, nargout}
3371 86873384cd10 [project @ 1999-11-21 17:31:07 by jwe] jwe parents: 2847 diff changeset	29 ## @end deftypefn
710 60af453e3f67 [project @ 1994-09-17 14:29:26 by jwe] jwe parents: diff changeset	30
8522 d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	31 ## Author: Bill Denney <bill@denney.ws>
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	32
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	33 function msg = nargchk (mina, maxa, narg, outtype)
2314 949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	34
8522 d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	35 if (nargin < 3 \|\| nargin > 4)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5307 diff changeset	36 print_usage ();
8522 d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	37 elseif (mina > maxa)
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	38 error ("nargchk: minargs must be <= maxargs");
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	39 elseif (nargin == 3)
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	40 outtype = "string";
9204 1f47a9404d93 nargchk.m: don't generate error if output is struct John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	41 elseif (! any (strcmpi (outtype, {"string", "struct"})))
8522 d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	42 error ("nargchk: output type must be either string or struct");
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	43 elseif (! (isscalar (mina) && isscalar (maxa) && isscalar (narg)))
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	44 error ("nargchk: mina, maxa, and narg must be scalars");
710 60af453e3f67 [project @ 1994-09-17 14:29:26 by jwe] jwe parents: diff changeset	45 endif
60af453e3f67 [project @ 1994-09-17 14:29:26 by jwe] jwe parents: diff changeset	46
8522 d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	47 msg = struct ("message", "", "identifier", "");
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	48 if (narg < mina)
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	49 msg.message = "not enough input arguments";
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	50 msg.identifier = "Octave:nargchk:not-enough-inputs";
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	51 elseif (narg > maxa)
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	52 msg.message = "too many input arguments";
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	53 msg.identifier = "Octave:nargchk:too-many-inputs";
710 60af453e3f67 [project @ 1994-09-17 14:29:26 by jwe] jwe parents: diff changeset	54 endif
60af453e3f67 [project @ 1994-09-17 14:29:26 by jwe] jwe parents: diff changeset	55
8522 d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	56 if (strcmpi (outtype, "string"))
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	57 msg = msg.message;
9204 1f47a9404d93 nargchk.m: don't generate error if output is struct John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	58 elseif (isempty (msg.message))
1f47a9404d93 nargchk.m: don't generate error if output is struct John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	59 msg = struct ([]);
710 60af453e3f67 [project @ 1994-09-17 14:29:26 by jwe] jwe parents: diff changeset	60 endif
60af453e3f67 [project @ 1994-09-17 14:29:26 by jwe] jwe parents: diff changeset	61
60af453e3f67 [project @ 1994-09-17 14:29:26 by jwe] jwe parents: diff changeset	62 endfunction
8522 d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	63
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	64 ## Tests
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	65 %!shared stmin, stmax
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	66 %! stmin = struct ("message", "not enough input arguments",
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	67 %! "identifier", "Octave:nargchk:not-enough-inputs");
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	68 %! stmax = struct ("message", "too many input arguments",
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	69 %! "identifier", "Octave:nargchk:too-many-inputs");
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	70 %!assert (nargchk (0, 1, 0), "")
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	71 %!assert (nargchk (0, 1, 1), "")
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	72 %!assert (nargchk (1, 1, 0), "not enough input arguments")
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	73 %!assert (nargchk (0, 1, 2), "too many input arguments")
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	74 %!assert (nargchk (0, 1, 2, "string"), "too many input arguments")
d65b33e55d40 nargchk.m: improve compatibility; new tests Peter L. Sondergaard <peter@sonderport.dk> parents: 7658 diff changeset	75 ## Struct outputs
9204 1f47a9404d93 nargchk.m: don't generate error if output is struct John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	76 %!assert (nargchk (0, 1, 0, "struct"), struct([]))
1f47a9404d93 nargchk.m: don't generate error if output is struct John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	77 %!assert (nargchk (0, 1, 1, "struct"), struct([]))
1f47a9404d93 nargchk.m: don't generate error if output is struct John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	78 %!assert (nargchk (1, 1, 0, "struct"), stmin)
1f47a9404d93 nargchk.m: don't generate error if output is struct John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	79 %!assert (nargchk (0, 1, 2, "struct"), stmax)

Mercurial > octave-nkf

annotate scripts/general/nargchk.m @ 10793:be55736a0783