gschur() was declared obsolete in Scilab 4, now removed
[scilab.git] / scilab / modules / functions / help / ja_JP / varargin.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) ????-2008 - INRIA
5  *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <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="ja">
17     <refnamediv>
18         <refname>varargin</refname>
19         <refpurpose>入力引数リストの引数の数を可変にする</refpurpose>
20     </refnamediv>
21     <refsection>
22         <title>説明</title>
23         <para>
24             最後の入力引数が<literal>varargin</literal>となる関数は
25             入力引数リストに示した数よりも多くの入力引数を指定して
26             コールすることができます.
27             <literal>varargin</literal>キーワードよりも後に渡された入力引数は,
28             関数内では<literal>varargin</literal>という名前のリストとして取得することが
29             できます.
30         </para>
31         <para>
32             <literal>varargin</literal>キーワードが形式的な入力引数リストの中で
33             <literal>n</literal>番目の引数と仮定すると,
34             関数が <literal>n-1</literal> 個未満の入力引数を指定して
35             コールされた場合,
36             <literal>varargin</literal>リストは定義されませんが,
37             <literal>n-1</literal>個の引数を指定してコールされた場合には
38             <literal>varargin</literal>リストは空のリストとなります.
39         </para>
40         <para>
41             <literal>function y= ex(varargin)</literal> は
42             任意の数の入力引数を指定してコールすることが可能です.
43             関数<literal>ex</literal>の中では, 入力引数は
44             <literal>varargin(i)</literal>, <literal>i=1:length(varargin)</literal>
45             により取得可能です.
46         </para>
47         <para>
48             関数の最後の入力引数ではない場合,
49             <literal>varargin</literal>は,特殊な意味を持たない通常の
50             入力引数の名前となります.
51         </para>
52         <para>
53             実際の入力引数の総数は,<code>argn(2)</code>で取得できます.
54         </para>
55     </refsection>
56     <refsection>
57         <title>注意</title>
58         <para>
59             <literal>foo(...,key=value)</literal> のような名前付き引数構文は
60             <literal>varargin</literal>とは互換性がありません.
61             その理由は,
62             値に対応する名前(すなわち, keys) が  <literal>varargin</literal> リストに
63             保存されないためです.
64             例えば,以下について考えてみてください:
65         </para>
66         <programlisting role="no-scilab-exec"><![CDATA[
67 function foo(varargin)
68     disp([varargin(1),varargin(2)])
69 endfunction
70         ]]></programlisting>
71         <screen>
72             -->foo(a=1,b=2)
73             1.    2.
74             -->foo(b=1,a=2)
75             1.    2.
76         </screen>
77         <para>結果は同じですが, 引数は逆になります.</para>
78     </refsection>
79     <refsection>
80         <title>例</title>
81         <programlisting role="example"><![CDATA[
82 function exampl(a,varargin)
83     [lhs,rhs]=argn(0)
84     if rhs>=1 then
85         disp(varargin)
86     end
87 endfunction
88 exampl(1)
89 exampl()
90 exampl(1,2,3)
91 l=list('a',%s,%t);
92 exampl(1,l(2:3))
93 ]]></programlisting>
94     </refsection>
95     <refsection role="see also">
96         <title>参照</title>
97         <simplelist type="inline">
98             <member>
99                 <link linkend="argn">argn</link>
100             </member>
101             <member>
102                 <link linkend="function">function</link>
103             </member>
104             <member>
105                 <link linkend="list">list</link>
106             </member>
107             <member>
108                 <link linkend="varargout">varargout</link>
109             </member>
110         </simplelist>
111     </refsection>
112 </refentry>