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