<?xml version="1.0" encoding="UTF-8"?>
<!--
 *
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2011 - DIGITEO - Michael Baudin
 *
 * Copyright (C) 2012 - 2016 - Scilab Enterprises
 *
 * This file is hereby licensed under the terms of the GNU GPL v2.0,
 * pursuant to article 5.3.4 of the CeCILL v.2.1.
 * This file was originally licensed under the terms of the CeCILL v2.1,
 * and continues to be available under such terms.
 * For more information, see the COPYING file which you should have received
 * along with this program.
 *
 -->
<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">
    <refnamediv>
        <refname>bitcmp</refname>
        <refpurpose>ビット毎の補数</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>呼び出し手順</title>
        <synopsis>
            y = bitcmp(x)
            y = bitcmp(x, bitnum)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>パラメータ</title>
        <variablelist>
            <varlistentry>
                <term>x :</term>
                <listitem>
                    <para>
                        <literal>m</literal>行<literal>n</literal>列の行列(double)または
                        <literal>m1</literal> x <literal>m2</literal>
                        x ... x <literal>mm</literal> ハイパー行列(double)
                        または符合なし整数(
                        <literal>uint8</literal>, <literal>uint16</literal> または
                        <literal>uint32</literal>)の
                        <literal>m</literal>行<literal>n</literal>列行列.
                        値は正の整数値である必要があります.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>n :</term>
                <listitem>
                    <para>
                        <literal>m</literal>行<literal>n</literal>列の行列(double)または
                        <literal>m1</literal> x <literal>m2</literal>
                        x ... x <literal>mm</literal> ハイパー行列(double)
                        または符合なし整数(
                        <literal>uint8</literal>, <literal>uint16</literal> または
                        <literal>uint32</literal>)の
                        <literal>m</literal>行<literal>n</literal>列行列.
                        入力<literal>n</literal>は 1,2,...,<literal>bitmax</literal>
                        の範囲であることが必要です.
                        ただし,<literal>bitmax</literal> は <varname>x</varname>
                        の最大ビット数です.
                        <varname>bitnum</varname>は,正の整数値である必要があります.
                        <varname>bitnum</varname>のデフォルト値は
                        <literal>bitmax</literal>です.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>y :</term>
                <listitem>
                    <para>
                        <literal>m</literal>行<literal>n</literal>列の行列(double)または
                        <literal>m1</literal> x <literal>m2</literal>
                        x ... x <literal>mm</literal> ハイパー行列(double)
                        または符合なし整数の
                        <literal>m</literal>行<literal>n</literal>列行列.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>説明</title>
        <para>
            符合なし整数<literal>x</literal>を指定すると, この関数は
            <literal>x</literal>の2進数形式の補数を値とする
            符合なし整数<varname>y</varname>を返します.
        </para>
        <para>
            整数 <varname>bitnum</varname> は最大ビット数を指定します.
        </para>
        <para>
            <literal>x</literal>の2進数表現のビット数が<literal>bitmax</literal>
            の値 (8, 16 または 32)
            よりも小さい場合, <literal>bitmax</literal>ビット
            (8, 16 または 32)の補数とするために
            ビット '1' がこの補数に付加されます.
        </para>
        <para>
            入力引数が1つのみの場合,
            <varname>x</varname> は符号無し整数の行列とする必要があります.
        </para>
    </refsection>
    <refsection>
        <title>例</title>
        <programlisting role="example"><![CDATA[
// 13 is (1101)_2
// We insert zeros in the begining to get a 8-bit number:
// (00001101)_2
// The 8-bits complement is then (11110010)_2
// which is 242
bitcmp(13,8)
expected = 242
// The input argument can be an unsigned int
bitcmp(uint8(99),8)
expected = 156
   ]]></programlisting>
    </refsection>
</refentry>
