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
|
<?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="varargout" xml:lang="en">
<refnamediv>
<refname>varargout</refname>
<refpurpose>variable numbers of arguments in an output argument
list
</refpurpose>
</refnamediv>
<refsection>
<title>Description</title>
<para>A function whose output argument list contains
<literal>varargout</literal> must be called with more output arguments
than indicated in the output argument list. The calling arguments passed
form <literal>varargout</literal> keyword onwards are extracted out of the
<literal>varargout</literal> list defined in the function.
</para>
<para>
<literal>varargout = function ex()</literal> may be called with any
number of output arguments. Within function <literal>ex</literal> output
arguments may be stored in <literal>varargout(i)</literal>.
</para>
<para>
<literal>[X1,...,Xn,varargout] = function ex()</literal> may also be
used. In this case the <literal>Xi</literal> variables must be assigned in
the function as well as <literal>varargout(i)</literal>.
</para>
<para>
The actual total number of output argument is given <code>argn(1)</code>.
</para>
</refsection>
<refsection>
<title>Remark</title>
<para>
The <literal>varargout</literal> variable must be created within the
function and assigned to a <link linkend="list">list</link>. If <literal>varargout</literal>
is the only formal output variable the list must contain at least one
entry.
</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
function varargout=exampl()
varargout=list(1,2,3,4)
endfunction
x=exampl()
[x,y]=exampl()
[x,y,z]=exampl()
function [a,b,varargout]=exampl1()
a='first'
b='second'
varargout=list(1,2,3,4)
endfunction
exampl1()
[a,b]=exampl1()
[a,b,c]=exampl1()
]]></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="varargin">varargin</link>
</member>
</simplelist>
</refsection>
</refentry>
|
