Fix all the formatting of xml files
[scilab.git] / scilab / modules / elementary_functions / help / ja_JP / bitwise / bitcmp.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * 
4  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
5  * Copyright (C) 2011 - DIGITEO - Michael Baudin
6  * 
7  * This file must be used under the terms of the CeCILL.
8  * This source file is licensed as described in the file COPYING, which
9  * you should have received as part of this distribution.  The terms
10  * are also available at    
11  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
12  * 
13  -->
14 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="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="bitcmp" xml:lang="ja">
15     <refnamediv>
16         <refname>bitcmp</refname>
17         <refpurpose>ビット毎の補数</refpurpose>
18     </refnamediv>
19     <refsynopsisdiv>
20         <title>呼び出し手順</title>
21         <synopsis>
22             y = bitcmp(x,n)
23         </synopsis>
24     </refsynopsisdiv>
25     <refsection>
26         <title>パラメータ</title>
27         <variablelist>
28             <varlistentry>
29                 <term>x :</term>
30                 <listitem>
31                     <para>
32                         m行n列の行列(double)またはm1 x m2 x ... x mm ハイパー行列(double)
33                         または符合なし整数(uint8, uint16 または uint32)の
34                         m行n列行列.値は正の整数値である必要があります.
35                     </para>
36                 </listitem>
37             </varlistentry>
38             <varlistentry>
39                 <term>n :</term>
40                 <listitem>
41                     <para>
42                         m行n列の行列(double)またはm1 x m2 x ... x mm ハイパー行列(double)
43                         または符合なし整数(uint8, uint16 または uint32)の
44                         m行n列行列.
45                         入力<literal>n</literal>は 1,2,...,bitmax の範囲であることが
46                         必要です.
47                         ただし,bitmax は x の最大ビット数です.
48                         値は正の整数値である必要があります.
49                     </para>
50                 </listitem>
51             </varlistentry>
52             <varlistentry>
53                 <term>y :</term>
54                 <listitem>
55                     <para>
56                         m行n列の行列(double)またはm1 x m2 x ... x mm ハイパー行列(double)
57                         または符合なし整数のm行n列行列.
58                     </para>
59                 </listitem>
60             </varlistentry>
61         </variablelist>
62     </refsection>
63     <refsection>
64         <title>説明</title>
65         <para>
66             符合なし整数<literal>x</literal>を指定すると, この関数は
67             <literal>x</literal>の2進数形式の補数を値とする
68             符合なし整数を返します.
69         </para>
70         <para>
71             整数 <literal>n</literal> は最大ビット数を指定します.
72         </para>
73         <para>
74             <literal>x</literal>の2進数表現のビット数が bitmax の値 (8, 16 または 32)
75             よりも小さい場合, bitmax ビット (8, 16 または 32)の補数とするために
76             ビット '1' がこの補数に付加されます.
77         </para>
78     </refsection>
79     <refsection>
80         <title>例</title>
81         <programlisting role="example"><![CDATA[
82 // 13 is (1101)_2
83 // We insert zeros in the begining to get a 8-bit number:
84 // (00001101)_2
85 // The 8-bits complement is then (11110010)_2
86 // which is 242
87 bitcmp(13,8)
88 expected = 242
89
90 // The input argument can be an unsigned int
91 bitcmp(uint8(99),8)
92 expected = 156
93    ]]></programlisting>
94     </refsection>
95 </refentry>