GPL + CeCILL Header change
[scilab.git] / scilab / modules / elementary_functions / help / ja_JP / matrixmanipulation / flipdim.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 - Farid BELAHCENE
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  * === LICENSE_END ===
15  *
16  -->
17 <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="flipdim" xml:lang="ja">
18     <refnamediv>
19         <refname>flipdim</refname>
20         <refpurpose>指定した次元に沿って x ブロック要素を反転</refpurpose>
21     </refnamediv>
22     <refsynopsisdiv>
23         <title>呼び出し手順</title>
24         <synopsis>y = flipdim(x, dim [,sb])</synopsis>
25     </refsynopsisdiv>
26     <refsection>
27         <title>引数</title>
28         <variablelist>
29             <varlistentry>
30                 <term>x, y</term>
31                 <listitem>
32                     <para>任意の型, 同じ大きさのスカラー, ベクトル, 行列またはハイパー行列</para>
33                 </listitem>
34             </varlistentry>
35             <varlistentry>
36                 <term>dim</term>
37                 <listitem>
38                     <para>正の整数, 反転させる次元の番号</para>
39                 </listitem>
40             </varlistentry>
41             <varlistentry>
42                 <term>sb</term>
43                 <listitem>
44                     <para>正の整数, 交換するブロックの大きさ</para>
45                 </listitem>
46             </varlistentry>
47         </variablelist>
48     </refsection>
49     <refsection>
50         <title>説明</title>
51         <para>
52             任意の型のスカラー/ベクトル/配列/ハイパー行列 <literal>x</literal>と
53             2つの正の整数<literal>dim</literal>および<literal>sb</literal>を指定すると,
54             この関数は大きさ<literal>sb</literal>のブロック要素により
55             <literal>x</literal>の次元番号 <literal>dim</literal>
56             に沿って x の要素を反転します.
57             (<literal>x</literal> および <literal>y</literal> は同じ大きさとなります)
58         </para>
59         <para>
60             オプションパラメータ<literal>sb</literal> (Size Block) により,
61             ブロックの大きさ <literal>sb*size(x,2)</literal>
62             (<literal>dim=1</literal>) または <literal>size(x,1)*sb</literal> (<literal>dim=2</literal>)
63             での反転が可能となります.
64         </para>
65     </refsection>
66     <refsection>
67         <title>例</title>
68         <programlisting role="example"><![CDATA[ 
69 // 例 1: x の要素を最初の次元に沿って反転
70 x=[1 2 3 4; 5 6 7 8];
71 dim=1;
72 y=flipdim(x,dim)
73 // 例2: x の要素を2番目の次元に沿って反転
74 dim=2;
75 y=flipdim(x,dim)
76 // 例3: x の要素を3番目の次元に沿って反転
77 x=matrix(1:48,[3 2,4,2]);
78 dim=3;
79 y=flipdim(x,dim)
80 // 例4: 最初の例を複素数に
81 x = [1+%i 2*%i 3 4; 5 6-%i 7 8*%pi*%i]
82 dim = 1
83 y = flipdim(x, dim)
84 // 整数エンコードされた数値
85 x = int16(grand(4, 3, 2, "uin", -9, 9))
86 y = flipdim(x, 1)
87 // 論理値:
88 x = (grand(3, 4, "uin", -9, 9) > 0)
89 y = flipdim(x, 2)
90 // テキスト:
91 x = matrix(strsplit("a":"x", 1:23), 4, 6);
92 x = x+x
93 flipdim(x, 2)
94 // 多項式:
95 x = inv_coeff(grand(3, 9, "uin", 0, 3), 2)
96 flipdim(x, 1)
97 // 有理数:
98 n = inv_coeff(grand(3, 9, "uin", 0, 3), 2);
99 d = inv_coeff(grand(3, 9, "uin", 0, 3), 2);
100 r = n./d
101 flipdim(r, 2)
102  ]]></programlisting>
103         <para>
104             <literal>sb</literal>の使用例:
105         </para>
106         <programlisting role="example"><![CDATA[
107 X = [0 1 2 3 4 5 6 7 8 9 10 11];
108 flipdim(X, 2, 2) // => [10 11   8 9   6 7   4 5   2 3   0 1] // ブロックサイズ = 2.
109 flipdim(X, 2, 3) // => [9 10 11   6 7 8   3 4 5   0 1 2]
110 flipdim(X, 2, 4) // => [8 9 10 11   4 5 6 7   0 1 2 3]
111 flipdim(X, 2, 6) // => [6 7 8 9 10 11   0 1 2 3 4 5]
112 // sbがxの指定した次元を分割しない場合はエラー.
113 y = flipdim(x, 2, 5); // size(X) = [1 12] および sb=5 は 12を割り切れない.
114  ]]></programlisting>
115     </refsection>
116     <refsection>
117         <title>履歴</title>
118         <revhistory>
119             <revision>
120                 <revnumber>5.5.0</revnumber>
121                 <revremark>
122                     10進数から任意の型に拡張: 論理値, 整数, 文字列, 多項式および有理数.
123                     <literal>x</literal>ブロック毎に反転するために,
124                     新しい入力引数 <literal>sb</literal>が追加されました.
125                 </revremark>
126             </revision>
127         </revhistory>
128     </refsection>
129 </refentry>