1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<HEAD>
<TITLE>NARGIN Number of Input Arguments
</TITLE>
</HEAD>
<BODY>
<H2>NARGIN Number of Input Arguments
</H2>
<P>
Section: <A HREF=sec_functions.html> Functions and Scripts </A>
<H3>Usage</H3>
The <code>nargin</code> function returns the number of arguments passed
to a function when it was called. The general syntax for its
use is
<PRE>
y = nargin
</PRE>
<P>
FreeMat allows for
fewer arguments to be passed to a function than were declared,
and <code>nargin</code>, along with <code>isset</code> can be used to determine
exactly what subset of the arguments were defined.
<H3>Example</H3>
Here is a function that is declared to take five
arguments, and that simply prints the value of <code>nargin</code>
each time it is called.
<P>
<PRE>
nargintest.m
function nargintest(a1,a2,a3,a4,a5)
printf('nargin = %d\n',nargin);
</PRE>
<P>
<PRE>
--> nargintest(3);
nargin = 1
--> nargintest(3,'h');
nargin = 2
--> nargintest(3,'h',1.34);
nargin = 3
--> nargintest(3,'h',1.34,pi,e);
nargin = 5
</PRE>
<P>
</BODY>
</HTML>
|
