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.1-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)
  23             y = bitcmp(x, bitnum)
  24         </synopsis>
  25     </refsynopsisdiv>
  26     <refsection>
  27         <title>パラメータ</title>
  28         <variablelist>
  29             <varlistentry>
  30                 <term>x :</term>
  31                 <listitem>
  32                     <para>
  33                         <literal>m</literal>行<literal>n</literal>列の行列(double)または
  34                         <literal>m1</literal> x <literal>m2</literal>
  35                         x ... x <literal>mm</literal> ハイパー行列(double)
  36                         または符合なし整数(
  37                         <literal>uint8</literal>, <literal>uint16</literal> または
  38                         <literal>uint32</literal>)の
  39                         <literal>m</literal>行<literal>n</literal>列行列.
  40                         値は正の整数値である必要があります.
  41                     </para>
  42                 </listitem>
  43             </varlistentry>
  44             <varlistentry>
  45                 <term>n :</term>
  46                 <listitem>
  47                     <para>
  48                         <literal>m</literal>行<literal>n</literal>列の行列(double)または
  49                         <literal>m1</literal> x <literal>m2</literal>
  50                         x ... x <literal>mm</literal> ハイパー行列(double)
  51                         または符合なし整数(
  52                         <literal>uint8</literal>, <literal>uint16</literal> または
  53                         <literal>uint32</literal>)の
  54                         <literal>m</literal>行<literal>n</literal>列行列.
  55                         入力<literal>n</literal>は 1,2,...,<literal>bitmax</literal>
  56                         の範囲であることが必要です.
  57                         ただし,<literal>bitmax</literal> は <varname>x</varname>
  58                         の最大ビット数です.
  59                         <varname>bitnum</varname>は,正の整数値である必要があります.
  60                         <varname>bitnum</varname>のデフォルト値は
  61                         <literal>bitmax</literal>です.
  62                     </para>
  63                 </listitem>
  64             </varlistentry>
  65             <varlistentry>
  66                 <term>y :</term>
  67                 <listitem>
  68                     <para>
  69                         <literal>m</literal>行<literal>n</literal>列の行列(double)または
  70                         <literal>m1</literal> x <literal>m2</literal>
  71                         x ... x <literal>mm</literal> ハイパー行列(double)
  72                         または符合なし整数の
  73                         <literal>m</literal>行<literal>n</literal>列行列.
  74                     </para>
  75                 </listitem>
  76             </varlistentry>
  77         </variablelist>
  78     </refsection>
  79     <refsection>
  80         <title>説明</title>
  81         <para>
  82             符合なし整数<literal>x</literal>を指定すると, この関数は
  83             <literal>x</literal>の2進数形式の補数を値とする
  84             符合なし整数<varname>y</varname>を返します.
  85         </para>
  86         <para>
  87             整数 <varname>bitnum</varname> は最大ビット数を指定します.
  88         </para>
  89         <para>
  90             <literal>x</literal>の2進数表現のビット数が<literal>bitmax</literal>
  91             の値 (8, 16 または 32)
  92             よりも小さい場合, <literal>bitmax</literal>ビット
  93             (8, 16 または 32)の補数とするために
  94             ビット '1' がこの補数に付加されます.
  95         </para>
  96         <para>
  97             入力引数が1つのみの場合,
  98             <varname>x</varname> は符号無し整数の行列とする必要があります.
  99         </para>
 100     </refsection>
 101     <refsection>
 102         <title>例</title>
 103         <programlisting role="example"><![CDATA[
 104 // 13 is (1101)_2
 105 // We insert zeros in the begining to get a 8-bit number:
 106 // (00001101)_2
 107 // The 8-bits complement is then (11110010)_2
 108 // which is 242
 109 bitcmp(13,8)
 110 expected = 242
 111 // The input argument can be an unsigned int
 112 bitcmp(uint8(99),8)
 113 expected = 156
 114    ]]></programlisting>
 115     </refsection>
 116 </refentry>