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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
* Copyright (C) ????-2008 - INRIA
*
* This file must be used under the terms of the CeCILL.
* This source file is licensed as described in the file COPYING, which
* you should have received as part of this distribution. The terms
* are also available at
* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
*
-->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="varargin" xml:lang="en">
<refnamediv>
<refname>varargin</refname>
<refpurpose>variable number of arguments in an input argument
list
</refpurpose>
</refnamediv>
<refsection>
<title>Description</title>
<para>
A function whose last input argument is <literal>varargin</literal>
can be called with more input arguments than indicated in the input
argument list. The calling arguments passed form
<literal>varargin</literal> keyword onwards may then be retrieved within
the function in a list named <literal>varargin</literal>.
</para>
<para>
Suppose that <literal>varargin</literal> keyword is the
<literal>n</literal>-th argument of the formal input argument list, then
if the function is called with less than <literal>n-1</literal> input
arguments the <literal>varargin</literal> list is not defined, if the
function is called with <literal>n-1</literal> arguments then
<literal>varargin</literal> list is an empty list.
</para>
<para>
<literal>function y = ex(varargin)</literal> may be called with any
number of input arguments. Within function <literal>ex</literal> input
arguments may be retrieved in <literal>varargin(i)</literal>, <literal>i=1:length(varargin)</literal>.
</para>
<para>
If it is not the last input argument of a function,
<literal>varargin</literal> is a normal input argument name with no
special meaning.
</para>
<para>
The total number of actual input arguments is given by <code>argn(2)</code>.
</para>
</refsection>
<refsection>
<title>Remark</title>
<para>
Named argument syntax like <literal>foo(...,key=value)</literal> is
incompatible with the use of <literal>varargin</literal>. The reason is that the names (i.e.
keys) associated with values are not stored in the <literal>varargin</literal> list. Consider
for instance:
</para>
<programlisting role="no-scilab-exec"><![CDATA[
function foo(varargin)
disp([varargin(1),varargin(2)])
endfunction
]]></programlisting>
<screen>
-->foo(a=1,b=2)
1. 2.
-->foo(b=1,a=2)
1. 2.
</screen>
<para>
Result is the same, but the arguments were inverted.
</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
function exampl(a,varargin)
[lhs,rhs]=argn(0)
if rhs>=1 then
disp(varargin)
end
endfunction
exampl(1)
exampl()
exampl(1,2,3)
l=list('a',%s,%t);
exampl(1,l(2:3))
]]></programlisting>
</refsection>
<refsection role="see also">
<title>See Also</title>
<simplelist type="inline">
<member>
<link linkend="argn">argn</link>
</member>
<member>
<link linkend="function">function</link>
</member>
<member>
<link linkend="list">list</link>
</member>
<member>
<link linkend="varargout">varargout</link>
</member>
</simplelist>
</refsection>
</refentry>
|
