Mercurial > octave-nkf

annotate scripts/general/nargchk.m @ 7017:a1dbe9d80eee

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[project @ 2007-10-12 21:27:11 by jwe]
author jwe
date Fri, 12 Oct 2007 21:27:37 +0000
parents 93c65f2a5668
children 1ce6460aebdf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
1 ## Copyright (C) 1994, 1995, 1996, 1997, 1999, 2000, 2005, 2006, 2007
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
2 ## John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
3 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
4 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
5 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
6 ## 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
7 ## 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
8 ## 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
9 ## your option) any later version.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
10 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
11 ## 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
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
13 ## 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
14 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
15 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
16 ## 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
17 ## 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
18 ## <http://www.gnu.org/licenses/>.
710
60af453e3f67 [project @ 1994-09-17 14:29:26 by jwe]
jwe
parents:
diff changeset
19
3371
86873384cd10 [project @ 1999-11-21 17:31:07 by jwe]
jwe
parents: 2847
diff changeset
20 ## -*- texinfo -*-
86873384cd10 [project @ 1999-11-21 17:31:07 by jwe]
jwe
parents: 2847
diff changeset
21 ## @deftypefn {Function File} {} nargchk (@var{nargin_min}, @var{nargin_max}, @var{n})
86873384cd10 [project @ 1999-11-21 17:31:07 by jwe]
jwe
parents: 2847
diff changeset
22 ## If @var{n} is in the range @var{nargin_min} through @var{nargin_max}
86873384cd10 [project @ 1999-11-21 17:31:07 by jwe]
jwe
parents: 2847
diff changeset
23 ## inclusive, return the empty matrix. Otherwise, return a message
86873384cd10 [project @ 1999-11-21 17:31:07 by jwe]
jwe
parents: 2847
diff changeset
24 ## indicating whether @var{n} is too large or too small.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3371
diff changeset
25 ##
3371
86873384cd10 [project @ 1999-11-21 17:31:07 by jwe]
jwe
parents: 2847
diff changeset
26 ## This is useful for checking to see that the number of arguments supplied
86873384cd10 [project @ 1999-11-21 17:31:07 by jwe]
jwe
parents: 2847
diff changeset
27 ## to a function is within an acceptable range.
86873384cd10 [project @ 1999-11-21 17:31:07 by jwe]
jwe
parents: 2847
diff changeset
28 ## @end deftypefn
710
60af453e3f67 [project @ 1994-09-17 14:29:26 by jwe]
jwe
parents:
diff changeset
29
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
30 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
31
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
32 function retval = nargchk (nargin_min, nargin_max, n)
710
60af453e3f67 [project @ 1994-09-17 14:29:26 by jwe]
jwe
parents:
diff changeset
33
60af453e3f67 [project @ 1994-09-17 14:29:26 by jwe]
jwe
parents:
diff changeset
34 if (nargin != 3)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5307
diff changeset
35 print_usage ();
710
60af453e3f67 [project @ 1994-09-17 14:29:26 by jwe]
jwe
parents:
diff changeset
36 endif
60af453e3f67 [project @ 1994-09-17 14:29:26 by jwe]
jwe
parents:
diff changeset
37
60af453e3f67 [project @ 1994-09-17 14:29:26 by jwe]
jwe
parents:
diff changeset
38 if (nargin_min > nargin_max)
60af453e3f67 [project @ 1994-09-17 14:29:26 by jwe]
jwe
parents:
diff changeset
39 error ("nargchk: nargin_min > nargin_max");
60af453e3f67 [project @ 1994-09-17 14:29:26 by jwe]
jwe
parents:
diff changeset
40 endif
60af453e3f67 [project @ 1994-09-17 14:29:26 by jwe]
jwe
parents:
diff changeset
41
60af453e3f67 [project @ 1994-09-17 14:29:26 by jwe]
jwe
parents:
diff changeset
42 if (n < nargin_min)
60af453e3f67 [project @ 1994-09-17 14:29:26 by jwe]
jwe
parents:
diff changeset
43 retval = "nargchk: N is less than nargin_min";
60af453e3f67 [project @ 1994-09-17 14:29:26 by jwe]
jwe
parents:
diff changeset
44 elseif (n > nargin_max)
60af453e3f67 [project @ 1994-09-17 14:29:26 by jwe]
jwe
parents:
diff changeset
45 retval = "nargchk: N is greater than nargin_max";
60af453e3f67 [project @ 1994-09-17 14:29:26 by jwe]
jwe
parents:
diff changeset
46 else
60af453e3f67 [project @ 1994-09-17 14:29:26 by jwe]
jwe
parents:
diff changeset
47 retval = [];
60af453e3f67 [project @ 1994-09-17 14:29:26 by jwe]
jwe
parents:
diff changeset
48 endif
60af453e3f67 [project @ 1994-09-17 14:29:26 by jwe]
jwe
parents:
diff changeset
49
60af453e3f67 [project @ 1994-09-17 14:29:26 by jwe]
jwe
parents:
diff changeset
50 endfunction