length(): documents changes for cells and structures arrays
[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             The length of an array M of cells or of structures is the number of elements of the array.
61             It is equivalent to <literal>size(M, "*")</literal>.
62         </para>
63         <para>
64             mlistのlengthはデフォルトでmlistの要素数ですが,
65             オーバーロードすることができます(例参照).
66             文字列でないハイパー行列は,
67             関数をオーバーロードする必要がないことに注意してください.
68             さもなくば,<function>length</function>は
69             ハイパー行列の次元の積を返します.
70         </para>
71         <para>
72             <literal>length('123')</literal>は <literal>3</literal>となります.
73             <literal>length([1,2;3,4])</literal>は <literal>4</literal>となります.
74         </para>
75         <para>
76             <warning>
77                 警告 :
78                 疎行列の<function>length</function>は,
79                 行列の最大次元を返し,次元の積ではありません.
80                 (例えば:
81                 <code>length(sparse(eye(12,2)))</code>は,
82                 <literal>24</literal>)ではなく<code>max(12,2)</code> を返します.
83                 疎行列の場合は <literal>size(...,'*')</literal>を使用してください.
84             </warning>
85         </para>
86     </refsection>
87     <refsection>
88         <title>例</title>
89         <programlisting role="example"><![CDATA[
90 length([123 ; 456 ])
91 length(['hello world',SCI])
92 length(rand(2,2,2))
93     ]]></programlisting>
94         <programlisting role="example"><![CDATA[
95 a = mlist(["myMlistT" "field1" "field2"],"aexample","bexampleb");
96 length(a)
97 // lengthがmlistにオーバーロードされたいない場合のデフォルトの動作は3を返す
98 // mlist型myMlistTのオーバーロード関数を作成
99 function r = %myMlistT_length(M)
100     r = length(M.field1)
101 endfunction
102 length(a)
103 // length(a.field1)の結果8を返す
104     ]]></programlisting>
105     </refsection>
106     <refsection role="see also">
107         <title>参照</title>
108         <simplelist type="inline">
109             <member>
110                 <link linkend="size">size</link>
111             </member>
112         </simplelist>
113     </refsection>
114     <refsection>
115         <title>履歴</title>
116         <revhistory>
117             <revision>
118                 <revnumber>5.4.0</revnumber>
119                 <revremark>
120                     この関数によりmlist型のオーバーロードが可能となりました.
121                 </revremark>
122             </revision>
123             <revision>
124                 <revnumber>6.0.0</revnumber>
125                 <revremark>
126                     <itemizedlist>
127                         <listitem>
128                             The <literal>length()</literal> of any array C of cells was formerly
129                             always 3, whatever are the number of dimensions and the sizes of the
130                             array. It is now the number of elements of the array at null depth
131                             (without recursive counting), equal to <literal>size(C, "*")</literal>.
132                         </listitem>
133                         <listitem>
134                             The <literal>length()</literal> of any array S of structures was formerly
135                             equal to its number of fields +2, whatever are the number of dimensions
136                             and the sizes of the array. It is now the number of elements of the
137                             array at null depth, equal to <literal>size(S, "*")</literal>.
138                         </listitem>
139                     </itemizedlist>
140                 </revremark>
141             </revision>
142         </revhistory>
143     </refsection>
144 </refentry>