<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Data.Bits</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Data-Bits.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">base-4.5.1.0: Basic libraries</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>portable</td></tr><tr><th>Stability</th><td>experimental</td></tr><tr><th>Maintainer</th><td>libraries@haskell.org</td></tr><tr><th>Safe Haskell</th><td>Trustworthy</td></tr></table><p class="caption">Data.Bits</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>This module defines bitwise operations for signed and unsigned
integers. Instances of the class <code><a href="Data-Bits.html#t:Bits">Bits</a></code> for the <code><a href="Data-Int.html#t:Int">Int</a></code> and
<code><a href="Prelude.html#t:Integer">Integer</a></code> types are available from this module, and instances for
explicitly sized integral types are available from the
<a href="Data-Int.html">Data.Int</a> and <a href="Data-Word.html">Data.Word</a> modules.
</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">class</span> (<a href="Data-Eq.html#t:Eq">Eq</a> a, <a href="Prelude.html#t:Num">Num</a> a) => <a href="#t:Bits">Bits</a> a <span class="keyword">where</span><ul class="subs"><li><a href="#v:.-38-.">(.&.)</a> :: a -> a -> a</li><li><a href="#v:.-124-.">(.|.)</a> :: a -> a -> a</li><li><a href="#v:xor">xor</a> :: a -> a -> a</li><li><a href="#v:complement">complement</a> :: a -> a</li><li><a href="#v:shift">shift</a> :: a -> <a href="Data-Int.html#t:Int">Int</a> -> a</li><li><a href="#v:rotate">rotate</a> :: a -> <a href="Data-Int.html#t:Int">Int</a> -> a</li><li><a href="#v:bit">bit</a> :: <a href="Data-Int.html#t:Int">Int</a> -> a</li><li><a href="#v:setBit">setBit</a> :: a -> <a href="Data-Int.html#t:Int">Int</a> -> a</li><li><a href="#v:clearBit">clearBit</a> :: a -> <a href="Data-Int.html#t:Int">Int</a> -> a</li><li><a href="#v:complementBit">complementBit</a> :: a -> <a href="Data-Int.html#t:Int">Int</a> -> a</li><li><a href="#v:testBit">testBit</a> :: a -> <a href="Data-Int.html#t:Int">Int</a> -> <a href="Data-Bool.html#t:Bool">Bool</a></li><li><a href="#v:bitSize">bitSize</a> :: a -> <a href="Data-Int.html#t:Int">Int</a></li><li><a href="#v:isSigned">isSigned</a> :: a -> <a href="Data-Bool.html#t:Bool">Bool</a></li><li><a href="#v:shiftL">shiftL</a> :: a -> <a href="Data-Int.html#t:Int">Int</a> -> a</li><li><a href="#v:unsafeShiftL">unsafeShiftL</a> :: a -> <a href="Data-Int.html#t:Int">Int</a> -> a</li><li><a href="#v:shiftR">shiftR</a> :: a -> <a href="Data-Int.html#t:Int">Int</a> -> a</li><li><a href="#v:unsafeShiftR">unsafeShiftR</a> :: a -> <a href="Data-Int.html#t:Int">Int</a> -> a</li><li><a href="#v:rotateL">rotateL</a> :: a -> <a href="Data-Int.html#t:Int">Int</a> -> a</li><li><a href="#v:rotateR">rotateR</a> :: a -> <a href="Data-Int.html#t:Int">Int</a> -> a</li><li><a href="#v:popCount">popCount</a> :: a -> <a href="Data-Int.html#t:Int">Int</a></li></ul></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">class</span> (<a href="Data-Eq.html#t:Eq">Eq</a> a, <a href="Prelude.html#t:Num">Num</a> a) => <a name="t:Bits" class="def">Bits</a> a <span class="keyword">where</span></p><div class="doc"><p>The <code><a href="Data-Bits.html#t:Bits">Bits</a></code> class defines bitwise operations over integral types.
</p><ul><li> Bits are numbered from 0 with bit 0 being the least
significant bit.
</li></ul><p>Minimal complete definition: <code><a href="Data-Bits.html#v:.-38-.">.&.</a></code>, <code><a href="Data-Bits.html#v:.-124-.">.|.</a></code>, <code><a href="Data-Bits.html#v:xor">xor</a></code>, <code><a href="Data-Bits.html#v:complement">complement</a></code>,
(<code><a href="Data-Bits.html#v:shift">shift</a></code> or (<code><a href="Data-Bits.html#v:shiftL">shiftL</a></code> and <code><a href="Data-Bits.html#v:shiftR">shiftR</a></code>)), (<code><a href="Data-Bits.html#v:rotate">rotate</a></code> or (<code><a href="Data-Bits.html#v:rotateL">rotateL</a></code> and <code><a href="Data-Bits.html#v:rotateR">rotateR</a></code>)),
<code><a href="Data-Bits.html#v:bitSize">bitSize</a></code> and <code><a href="Data-Bits.html#v:isSigned">isSigned</a></code>.
</p></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:.-38-." class="def">(.&.)</a> :: a -> a -> a</p><div class="doc"><p>Bitwise "and"
</p></div><p class="src"><a name="v:.-124-." class="def">(.|.)</a> :: a -> a -> a</p><div class="doc"><p>Bitwise "or"
</p></div><p class="src"><a name="v:xor" class="def">xor</a> :: a -> a -> a</p><div class="doc"><p>Bitwise "xor"
</p></div><p class="src"><a name="v:complement" class="def">complement</a> :: a -> a</p><div class="doc"><p>Reverse all the bits in the argument
</p></div><p class="src"><a name="v:shift" class="def">shift</a> :: a -> <a href="Data-Int.html#t:Int">Int</a> -> a</p><div class="doc"><p><code><code><a href="Data-Bits.html#v:shift">shift</a></code> x i</code> shifts <code>x</code> left by <code>i</code> bits if <code>i</code> is positive,
or right by <code>-i</code> bits otherwise.
Right shifts perform sign extension on signed number types;
i.e. they fill the top bits with 1 if the <code>x</code> is negative
and with 0 otherwise.
</p><p>An instance can define either this unified <code><a href="Data-Bits.html#v:shift">shift</a></code> or <code><a href="Data-Bits.html#v:shiftL">shiftL</a></code> and
<code><a href="Data-Bits.html#v:shiftR">shiftR</a></code>, depending on which is more convenient for the type in
question.
</p></div><p class="src"><a name="v:rotate" class="def">rotate</a> :: a -> <a href="Data-Int.html#t:Int">Int</a> -> a</p><div class="doc"><p><code><code><a href="Data-Bits.html#v:rotate">rotate</a></code> x i</code> rotates <code>x</code> left by <code>i</code> bits if <code>i</code> is positive,
or right by <code>-i</code> bits otherwise.
</p><p>For unbounded types like <code><a href="Prelude.html#t:Integer">Integer</a></code>, <code><a href="Data-Bits.html#v:rotate">rotate</a></code> is equivalent to <code><a href="Data-Bits.html#v:shift">shift</a></code>.
</p><p>An instance can define either this unified <code><a href="Data-Bits.html#v:rotate">rotate</a></code> or <code><a href="Data-Bits.html#v:rotateL">rotateL</a></code> and
<code><a href="Data-Bits.html#v:rotateR">rotateR</a></code>, depending on which is more convenient for the type in
question.
</p></div><p class="src"><a name="v:bit" class="def">bit</a> :: <a href="Data-Int.html#t:Int">Int</a> -> a</p><div class="doc"><p><code>bit i</code> is a value with the <code>i</code>th bit set and all other bits clear
</p></div><p class="src"><a name="v:setBit" class="def">setBit</a> :: a -> <a href="Data-Int.html#t:Int">Int</a> -> a</p><div class="doc"><p><code>x `setBit` i</code> is the same as <code>x .|. bit i</code>
</p></div><p class="src"><a name="v:clearBit" class="def">clearBit</a> :: a -> <a href="Data-Int.html#t:Int">Int</a> -> a</p><div class="doc"><p><code>x `clearBit` i</code> is the same as <code>x .&. complement (bit i)</code>
</p></div><p class="src"><a name="v:complementBit" class="def">complementBit</a> :: a -> <a href="Data-Int.html#t:Int">Int</a> -> a</p><div class="doc"><p><code>x `complementBit` i</code> is the same as <code>x `xor` bit i</code>
</p></div><p class="src"><a name="v:testBit" class="def">testBit</a> :: a -> <a href="Data-Int.html#t:Int">Int</a> -> <a href="Data-Bool.html#t:Bool">Bool</a></p><div class="doc"><p>Return <code><a href="Data-Bool.html#v:True">True</a></code> if the <code>n</code>th bit of the argument is 1
</p></div><p class="src"><a name="v:bitSize" class="def">bitSize</a> :: a -> <a href="Data-Int.html#t:Int">Int</a></p><div class="doc"><p>Return the number of bits in the type of the argument. The actual
value of the argument is ignored. The function <code><a href="Data-Bits.html#v:bitSize">bitSize</a></code> is
undefined for types that do not have a fixed bitsize, like <code><a href="Prelude.html#t:Integer">Integer</a></code>.
</p></div><p class="src"><a name="v:isSigned" class="def">isSigned</a> :: a -> <a href="Data-Bool.html#t:Bool">Bool</a></p><div class="doc"><p>Return <code><a href="Data-Bool.html#v:True">True</a></code> if the argument is a signed type. The actual
value of the argument is ignored
</p></div><p class="src"><a name="v:shiftL" class="def">shiftL</a> :: a -> <a href="Data-Int.html#t:Int">Int</a> -> a</p><div class="doc"><p>Shift the argument left by the specified number of bits
(which must be non-negative).
</p><p>An instance can define either this and <code><a href="Data-Bits.html#v:shiftR">shiftR</a></code> or the unified
<code><a href="Data-Bits.html#v:shift">shift</a></code>, depending on which is more convenient for the type in
question.
</p></div><p class="src"><a name="v:unsafeShiftL" class="def">unsafeShiftL</a> :: a -> <a href="Data-Int.html#t:Int">Int</a> -> a</p><div class="doc"><p>Shift the argument left by the specified number of bits. The
result is undefined for negative shift amounts and shift amounts
greater or equal to the <code><a href="Data-Bits.html#v:bitSize">bitSize</a></code>.
</p><p>Defaults to <code><a href="Data-Bits.html#v:shiftL">shiftL</a></code> unless defined explicitly by an instance.
</p></div><p class="src"><a name="v:shiftR" class="def">shiftR</a> :: a -> <a href="Data-Int.html#t:Int">Int</a> -> a</p><div class="doc"><p>Shift the first argument right by the specified number of bits. The
result is undefined for negative shift amounts and shift amounts
greater or equal to the <code><a href="Data-Bits.html#v:bitSize">bitSize</a></code>.
</p><p>Right shifts perform sign extension on signed number types;
i.e. they fill the top bits with 1 if the <code>x</code> is negative
and with 0 otherwise.
</p><p>An instance can define either this and <code><a href="Data-Bits.html#v:shiftL">shiftL</a></code> or the unified
<code><a href="Data-Bits.html#v:shift">shift</a></code>, depending on which is more convenient for the type in
question.
</p></div><p class="src"><a name="v:unsafeShiftR" class="def">unsafeShiftR</a> :: a -> <a href="Data-Int.html#t:Int">Int</a> -> a</p><div class="doc"><p>Shift the first argument right by the specified number of bits, which
must be non-negative an smaller than the number of bits in the type.
</p><p>Right shifts perform sign extension on signed number types;
i.e. they fill the top bits with 1 if the <code>x</code> is negative
and with 0 otherwise.
</p><p>Defaults to <code><a href="Data-Bits.html#v:shiftR">shiftR</a></code> unless defined explicitly by an instance.
</p></div><p class="src"><a name="v:rotateL" class="def">rotateL</a> :: a -> <a href="Data-Int.html#t:Int">Int</a> -> a</p><div class="doc"><p>Rotate the argument left by the specified number of bits
(which must be non-negative).
</p><p>An instance can define either this and <code><a href="Data-Bits.html#v:rotateR">rotateR</a></code> or the unified
<code><a href="Data-Bits.html#v:rotate">rotate</a></code>, depending on which is more convenient for the type in
question.
</p></div><p class="src"><a name="v:rotateR" class="def">rotateR</a> :: a -> <a href="Data-Int.html#t:Int">Int</a> -> a</p><div class="doc"><p>Rotate the argument right by the specified number of bits
(which must be non-negative).
</p><p>An instance can define either this and <code><a href="Data-Bits.html#v:rotateL">rotateL</a></code> or the unified
<code><a href="Data-Bits.html#v:rotate">rotate</a></code>, depending on which is more convenient for the type in
question.
</p></div><p class="src"><a name="v:popCount" class="def">popCount</a> :: a -> <a href="Data-Int.html#t:Int">Int</a></p><div class="doc"><p>Return the number of set bits in the argument. This number is
known as the population count or the Hamming weight.
</p></div></div><div class="subs instances"><p id="control.i:Bits" class="caption collapser" onclick="toggleSection('i:Bits')">Instances</p><div id="section.i:Bits" class="show"><table><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Data-Int.html#t:Int">Int</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Data-Int.html#t:Int8">Int8</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Data-Int.html#t:Int16">Int16</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Data-Int.html#t:Int32">Int32</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Data-Int.html#t:Int64">Int64</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Prelude.html#t:Integer">Integer</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Data-Word.html#t:Word">Word</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Data-Word.html#t:Word8">Word8</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Data-Word.html#t:Word16">Word16</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Data-Word.html#t:Word32">Word32</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Data-Word.html#t:Word64">Word64</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Foreign-C-Types.html#t:CUIntMax">CUIntMax</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Foreign-C-Types.html#t:CIntMax">CIntMax</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Foreign-C-Types.html#t:CUIntPtr">CUIntPtr</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Foreign-C-Types.html#t:CIntPtr">CIntPtr</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Foreign-C-Types.html#t:CSigAtomic">CSigAtomic</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Foreign-C-Types.html#t:CWchar">CWchar</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Foreign-C-Types.html#t:CSize">CSize</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Foreign-C-Types.html#t:CPtrdiff">CPtrdiff</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Foreign-C-Types.html#t:CULLong">CULLong</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Foreign-C-Types.html#t:CLLong">CLLong</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Foreign-C-Types.html#t:CULong">CULong</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Foreign-C-Types.html#t:CLong">CLong</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Foreign-C-Types.html#t:CUInt">CUInt</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Foreign-C-Types.html#t:CInt">CInt</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Foreign-C-Types.html#t:CUShort">CUShort</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Foreign-C-Types.html#t:CShort">CShort</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Foreign-C-Types.html#t:CUChar">CUChar</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Foreign-C-Types.html#t:CSChar">CSChar</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Foreign-C-Types.html#t:CChar">CChar</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Foreign-Ptr.html#t:IntPtr">IntPtr</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="Foreign-Ptr.html#t:WordPtr">WordPtr</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="System-Posix-Types.html#t:Fd">Fd</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="System-Posix-Types.html#t:CRLim">CRLim</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="System-Posix-Types.html#t:CTcflag">CTcflag</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="System-Posix-Types.html#t:CUid">CUid</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="System-Posix-Types.html#t:CNlink">CNlink</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="System-Posix-Types.html#t:CGid">CGid</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="System-Posix-Types.html#t:CSsize">CSsize</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="System-Posix-Types.html#t:CPid">CPid</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="System-Posix-Types.html#t:COff">COff</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="System-Posix-Types.html#t:CMode">CMode</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> <a href="System-Posix-Types.html#t:CIno">CIno</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> EventType</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Bits.html#t:Bits">Bits</a> Event</td><td class="doc empty"> </td></tr></table></div></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.11.0</p></div></body></html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
6e204a966e8c42d976f99a1700ce5f20
>
files
>
2235
