a7a737af9876147042c57c7cd19361e763163271
[scilab.git] / scilab / modules / string / help / ja_JP / length.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) 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="length" xml:lang="ja">
17     <refnamediv>
18         <refname>length</refname>
19         <refpurpose>オブジェクトの長さ</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>呼び出し手順</title>
23         <synopsis>n=length(M)</synopsis>
24     </refsynopsisdiv>
25     <refsection>
26         <title>引数</title>
27         <variablelist>
28             <varlistentry>
29                 <term>M</term>
30                 <listitem>
31                     <para>行列 (通常または多項式または文字列) または
32                         リスト
33                     </para>
34                 </listitem>
35             </varlistentry>
36             <varlistentry>
37                 <term>n</term>
38                 <listitem>
39                     <para>整数または整数行列</para>
40                 </listitem>
41             </varlistentry>
42         </variablelist>
43     </refsection>
44     <refsection>
45         <title>説明</title>
46         <para>
47             通常または多項式の行列の場合, <literal>n</literal>は
48             <literal>M</literal>の行の数に列の数を乗じた整数になります.
49             (<literal>M</literal>が論理値行列の場合にも有効)
50         </para>
51         <para>文字列からなる行列の場合 (および部分的に文字列の場合)
52             <literal>length</literal>は,
53             文字列の行列<literal>M</literal>のエントリの長さを
54             <literal>n</literal>に返します.
55         </para>
56         <para>リストの長さはリストの中の要素の長さです
57             (<literal>size</literal>でも出力されます).
58         </para>
59         <para>
60             mlistのlengthはデフォルトでmlistの要素数ですが,
61             オーバーロードすることができます(例参照).
62             文字列でないハイパー行列は,
63             関数をオーバーロードする必要がないことに注意してください.
64             さもなくば,<function>length</function>は
65             ハイパー行列の次元の積を返します.
66         </para>
67         <para>
68             <literal>length('123')</literal>は <literal>3</literal>となります.
69             <literal>length([1,2;3,4])</literal>は <literal>4</literal>となります.
70         </para>
71         <para>
72             <warning>
73                 警告 :
74                 疎行列の<function>length</function>は,
75                 行列の最大次元を返し,次元の積ではありません.
76                 (例えば:
77                 <code>length(sparse(eye(12,2)))</code>は,
78                 <literal>24</literal>)ではなく<code>max(12,2)</code> を返します.
79                 疎行列の場合は <literal>size(...,'*')</literal>を使用してください.
80             </warning>
81         </para>
82     </refsection>
83     <refsection>
84         <title>例</title>
85         <programlisting role="example"><![CDATA[
86 length([123 ; 456 ])
87 length(['hello world',SCI])
88 length(rand(2,2,2))
89     ]]></programlisting>
90         <programlisting role="example"><![CDATA[
91 a = mlist(["myMlistT" "field1" "field2"],"aexample","bexampleb");
92 length(a)
93 // lengthがmlistにオーバーロードされたいない場合のデフォルトの動作は3を返す
94 // mlist型myMlistTのオーバーロード関数を作成
95 function r = %myMlistT_length(M)
96     r = length(M.field1)
97 endfunction
98 length(a)
99 // length(a.field1)の結果8を返す
100     ]]></programlisting>
101     </refsection>
102     <refsection role="see also">
103         <title>参照</title>
104         <simplelist type="inline">
105             <member>
106                 <link linkend="size">size</link>
107             </member>
108         </simplelist>
109     </refsection>
110     <refsection>
111         <title>履歴</title>
112         <revhistory>
113             <revision>
114                 <revnumber>5.4.0</revnumber>
115                 <revremark>
116                     この関数によりmlist型のオーバーロードが可能となりました.
117                 </revremark>
118             </revision>
119         </revhistory>
120     </refsection>
121 </refentry>