Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r62521 - sandbox/SOC/2010/bits_and_ints/libs/integer/doc/html/boost_integer
From: muriloufg_at_[hidden]
Date: 2010-06-07 16:43:46

Author: murilov
Date: 2010-06-07 16:43:45 EDT (Mon, 07 Jun 2010)
New Revision: 62521
URL: http://svn.boost.org/trac/boost/changeset/62521

Log:
Added the html doc files to repository
Added:
sandbox/SOC/2010/bits_and_ints/libs/integer/doc/html/boost_integer/bits_and_ints.html (contents, props changed)

Added: sandbox/SOC/2010/bits_and_ints/libs/integer/doc/html/boost_integer/bits_and_ints.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bits_and_ints/libs/integer/doc/html/boost_integer/bits_and_ints.html 2010-06-07 16:43:45 EDT (Mon, 07 Jun 2010)
@@ -0,0 +1,923 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Bits and Ints</title>
+<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../index.html" title="Boost.Integer">
+<link rel="up" href="../index.html" title="Boost.Integer">
+<link rel="prev" href="log2.html" title="Compile Time log2 Calculation">
+<link rel="next" href="minmax.html" title="Compile time min/max calculation">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="log2.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="minmax.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" title="Bits and Ints">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="boost_integer.bits_and_ints"></a><a class="link" href="bits_and_ints.html" title="Bits and Ints"> Bits and Ints</a>
+</h2></div></div></div>
+<div class="toc"><dl>
+<dt> Sign Extending</dt>
+<dt> Bit Reversal</dt>
+<dt> Same Sign</dt>
+<dt> Sign function</dt>
+<dt> Binary Utilities</dt>
+</dl></div>
+
+ The intent of this library is to extend Boost.Integer with fast integer algorithms
+ and utilities. This library can be included via <boost/integer/bits_and_ints.hpp>.
+ 
+<div class="section" title="Sign Extending">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_integer.bits_and_ints.sign_extend"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.sign_extend" title="Sign Extending"> Sign Extending</a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="bits_and_ints.html#boost_integer.bits_and_ints.sign_extend.run_time_version">Run-time
+ version</a></dt>
+<dt><a href="bits_and_ints.html#boost_integer.bits_and_ints.sign_extend.compile_time_version">Compile-time
+ version</a></dt>
+<dt>Examples</dt>
+</dl></div>
+
+ Sign extension is automatic for built-in types, such as chars and ints. But
+ suppose you have a signed two's complement number, x, that is stored using
+ only b bits. Moreover, suppose you want to convert x to an int, which has
+ more than b bits. A simple copy will work if x is positive, but if negative,
+ the sign must be extended. For example, if we have only 4 bits to store a
+ number, then -3 is represented as 1101 in binary. If we have 8 bits, then
+ -3 is 11111101. The most-significant bit of the 4-bit representation is replicated
+ sinistrally to fill in the destination when we convert to a representation
+ with more bits; this is sign extending.
+ 
+<div class="section" title="Run-time version">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer.bits_and_ints.sign_extend.run_time_version"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.sign_extend.run_time_version" title="Run-time version">Run-time
+ version</a>
+</h4></div></div></div>
+
+ The run-time version can be included via <boost/integer/sign_extend.hpp>.
+ 
+<pre class="programlisting">template <typename Type>
+inline typename enable_if<is_integral<Type>, Type>::type
+sign_extend(Type data, std::size_t bits);
+</pre>
+<a name="boost_integer.bits_and_ints.sign_extend.run_time_version.parameters"></a><h5>
+<a name="id36188118"></a>
+ <a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.sign_extend.run_time_version.parameters">Parameters</a>
+ </h5>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Parameter
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">data</code>
+ 
+ </td>
+<td>
+ 
+ The data to be extended.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">bits</code>
+ 
+ </td>
+<td>
+ 
+ The amount of bits in wich data is represented.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="boost_integer.bits_and_ints.sign_extend.run_time_version.return"></a><h5>
+<a name="id36188215"></a>
+ <a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.sign_extend.run_time_version.return">Return</a>
+ </h5>
+
+ <code class="computeroutput">data</code> sign-extended to
+ <code class="computeroutput">sizeof(Type)</code>
+ bytes. The return type is <code class="computeroutput">Type</code>.
+ 
+</div>
+<div class="section" title="Compile-time version">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer.bits_and_ints.sign_extend.compile_time_version"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.sign_extend.compile_time_version" title="Compile-time version">Compile-time
+ version</a>
+</h4></div></div></div>
+
+ The compile-time version can be included via <boost/integer/static_sign_extend.hpp>.
+ The result will be in <code class="computeroutput">value</code>
+ member.
+ 
+<pre class="programlisting">template<typename Type, Type data, std::size_t Bits,
+ class Enable = implementation-defined>
+struct static_sign_extend
+{
+ static const Type value = implementation-defined;
+};
+</pre>
+<a name="boost_integer.bits_and_ints.sign_extend.compile_time_version.template_parameters"></a><h5>
+<a name="id36188440"></a>
+ <a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.sign_extend.compile_time_version.template_parameters">Template
+ Parameters</a>
+ </h5>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Parameter
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Type</code>
+ 
+ </td>
+<td>
+ 
+ The data type.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">data</code>
+ 
+ </td>
+<td>
+ 
+ The data to be extended.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Bits</code>
+ 
+ </td>
+<td>
+ 
+ The amount of bits in wich data is represented.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="section" title="Examples">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer.bits_and_ints.sign_extend.examples"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.sign_extend.examples" title="Examples">Examples</a>
+</h4></div></div></div>
+<a name="boost_integer.bits_and_ints.sign_extend.examples.run_time_version"></a><h5>
+<a name="id36188573"></a>
+ <a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.sign_extend.examples.run_time_version">Run-time
+ version</a>
+ </h5>
+<pre class="programlisting">#include <boost/integer/sign_extend.hpp>
+#include <iostream>
+
+int main()
+{
+ // data is represented in 24-bits
+ int data = 0xFFFFFF; // -1 in 24-bits
+
+ int result = boost::sign_extend(data, 24);
+
+ std::cout << result << std::endl; // -1
+}
+</pre>
+<a name="boost_integer.bits_and_ints.sign_extend.examples.compile_time_version"></a><h5>
+<a name="id36188811"></a>
+ <a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.sign_extend.examples.compile_time_version">Compile-time
+ version</a>
+ </h5>
+<pre class="programlisting">#include <boost/integer/static_sign_extend.hpp>
+#include <iostream>
+
+int main()
+{
+ // 0xFFFFF is -1 in 20-bits
+ int result = boost::static_sign_extend<int, 0xFFFFF, 20>::value;
+
+ std::cout << result << std::endl; // -1
+}
+</pre>
+</div>
+</div>
+<div class="section" title="Bit Reversal">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_integer.bits_and_ints.bit_reversal"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.bit_reversal" title="Bit Reversal"> Bit Reversal</a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="bits_and_ints.html#boost_integer.bits_and_ints.bit_reversal.run_time_version">Run-time
+ version</a></dt>
+<dt><a href="bits_and_ints.html#boost_integer.bits_and_ints.bit_reversal.compile_time_version">Compile-time
+ version</a></dt>
+<dt>Examples</dt>
+</dl></div>
+
+ The bit reversal functions reverts the bits of integral types.
+ 
+<div class="section" title="Run-time version">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer.bits_and_ints.bit_reversal.run_time_version"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.bit_reversal.run_time_version" title="Run-time version">Run-time
+ version</a>
+</h4></div></div></div>
+
+ The run-time version can be included via <boost/integer/bit_reversal.hpp>.
+ For valid types T, the function <code class="computeroutput">bit_reversal</code>
+ will be:
+ 
+<pre class="programlisting">template <typename T>
+inline T bit_reversal(T data);
+</pre>
+<a name="boost_integer.bits_and_ints.bit_reversal.run_time_version.parameters"></a><h5>
+<a name="id36189142"></a>
+ <a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.bit_reversal.run_time_version.parameters">Parameters</a>
+ </h5>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Parameter
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+ <code class="computeroutput">data</code>
+ 
+ </td>
+<td>
+ 
+ The data to be reversed. The type of data must
+ be an integral type and it's size must
+ be 8, 16, 32 or 64-bits, otherwise, bit_reversal(data) will result
+ in an error.
+ 
+ </td>
+</tr></tbody>
+</table></div>
+<a name="boost_integer.bits_and_ints.bit_reversal.run_time_version.return"></a><h5>
+<a name="id36189226"></a>
+ <a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.bit_reversal.run_time_version.return">Return</a>
+ </h5>
+
+ <code class="computeroutput">data</code> with its bits reversed.
+ 
+</div>
+<div class="section" title="Compile-time version">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer.bits_and_ints.bit_reversal.compile_time_version"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.bit_reversal.compile_time_version" title="Compile-time version">Compile-time
+ version</a>
+</h4></div></div></div>
+
+ The compile-time version can be included via <boost/integer/static_bit_reversal.hpp>.
+ The result will be in <code class="computeroutput">value</code>
+ member.
+ 
+<pre class="programlisting">template <typename T, T data, class Enable = implementation-defined>
+struct static_bit_reversal {
+ static const Type value = implementation-defined;
+};
+</pre>
+<a name="boost_integer.bits_and_ints.bit_reversal.compile_time_version.template_parameters"></a><h5>
+<a name="id36189402"></a>
+ <a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.bit_reversal.compile_time_version.template_parameters">Template
+ Parameters</a>
+ </h5>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Parameter
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">T</code>
+ 
+ </td>
+<td>
+ 
+ The data type.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">data</code>
+ 
+ </td>
+<td>
+ 
+ The data to be reversed.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="section" title="Examples">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer.bits_and_ints.bit_reversal.examples"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.bit_reversal.examples" title="Examples">Examples</a>
+</h4></div></div></div>
+<a name="boost_integer.bits_and_ints.bit_reversal.examples.run_time_version"></a><h5>
+<a name="id36189511"></a>
+ <a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.bit_reversal.examples.run_time_version">Run-time
+ version</a>
+ </h5>
+<pre class="programlisting">#include <boost/integer/bit_reversal.hpp>
+#include <iostream>
+
+int main()
+{
+ // data = 0101 0101
+ uint8_t data = 0x55;
+
+ uint8_t result = boost::bit_reversal(data);
+
+ // will print 0xaa (1010 1010)
+ std::cout << std::hex << result << std::endl; // -1
+}
+</pre>
+<a name="boost_integer.bits_and_ints.bit_reversal.examples.compile_time_version"></a><h5>
+<a name="id36189759"></a>
+ <a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.bit_reversal.examples.compile_time_version">Compile-time
+ version</a>
+ </h5>
+<pre class="programlisting">#include <boost/integer/static_bit_reversal.hpp>
+#include <iostream>
+
+int main()
+{
+ // 0x30A5 == 0011 0000 1010 0101
+ uint16_t result = boost::static_sign_extend<uint16_t, 0x30A5>::value;
+
+ // will print 0x5A0B
+ std::cout << std::hex << result << std::endl;
+}
+</pre>
+</div>
+</div>
+<div class="section" title="Same Sign">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_integer.bits_and_ints.same_sign"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.same_sign" title="Same Sign"> Same Sign</a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="bits_and_ints.html#boost_integer.bits_and_ints.same_sign.run_time_version">Run-time
+ version</a></dt>
+<dt><a href="bits_and_ints.html#boost_integer.bits_and_ints.same_sign.compile_time_version">Compile-time
+ version</a></dt>
+<dt>Examples</dt>
+</dl></div>
+
+ These functions check if wheter the sign of two integers are equal.
+ 
+<div class="section" title="Run-time version">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer.bits_and_ints.same_sign.run_time_version"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.same_sign.run_time_version" title="Run-time version">Run-time
+ version</a>
+</h4></div></div></div>
+
+ The run-time version can be included via <boost/integer/same_sign.hpp>.
+ For valid types T, the function <code class="computeroutput">bit_reversal</code>
+ will be:
+ 
+<pre class="programlisting">template <typename T>
+inline bool same_sign(T first, T second);
+</pre>
+<a name="boost_integer.bits_and_ints.same_sign.run_time_version.parameters"></a><h5>
+<a name="id36190114"></a>
+ <a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.same_sign.run_time_version.parameters">Parameters</a>
+ </h5>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Parameter
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+ <code class="computeroutput">first</code>, <code class="computeroutput">second</code>
+ 
+ </td>
+<td>
+ 
+ The two integral values to be compared. The type of data must be an integral type. <code class="computeroutput">first</code> and <code class="computeroutput">second</code>
+ must have the same type.
+ 
+ </td>
+</tr></tbody>
+</table></div>
+<a name="boost_integer.bits_and_ints.same_sign.run_time_version.return"></a><h5>
+<a name="id36190215"></a>
+ <a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.same_sign.run_time_version.return">Return</a>
+ </h5>
+
+ <code class="computeroutput">false</code>: if the signs of first
+ and second are different
+ 
+
+ <code class="computeroutput">true</code>: if the signs are equal
+ 
+</div>
+<div class="section" title="Compile-time version">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer.bits_and_ints.same_sign.compile_time_version"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.same_sign.compile_time_version" title="Compile-time version">Compile-time
+ version</a>
+</h4></div></div></div>
+
+ The compile-time version can be included via <boost/integer/same_sign.hpp>.
+ The result will be in <code class="computeroutput">value</code>
+ member.
+ 
+<pre class="programlisting">template <typename T, T first, T second, class Enable = implementation-defined>
+struct static_same_sign
+{
+ static const bool value = implementation-defined;
+};
+</pre>
+<a name="boost_integer.bits_and_ints.same_sign.compile_time_version.template_parameters"></a><h5>
+<a name="id36190416"></a>
+ <a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.same_sign.compile_time_version.template_parameters">Template
+ Parameters</a>
+ </h5>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Parameter
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">T</code>
+ 
+ </td>
+<td>
+ 
+ The data type.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">first</code>, <code class="computeroutput">second</code>
+ 
+ </td>
+<td>
+ 
+ The two integral values to be compared.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="section" title="Examples">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer.bits_and_ints.same_sign.examples"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.same_sign.examples" title="Examples">Examples</a>
+</h4></div></div></div>
+<a name="boost_integer.bits_and_ints.same_sign.examples.run_time_version"></a><h5>
+<a name="id36190530"></a>
+ <a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.same_sign.examples.run_time_version">Run-time
+ version</a>
+ </h5>
+<pre class="programlisting">#include <boost/integer/same_sign.hpp>
+#include <iostream>
+
+int main()
+{
+ int first = -1, second = -2, third = 1;
+
+ bool result = boost::same_sign(first, second);
+ std::cout << result << std::endl; // true
+
+ result = boost::same_sign(first, third);
+ std::cout << result << std::endl; // false
+}
+</pre>
+<a name="boost_integer.bits_and_ints.same_sign.examples.compile_time_version"></a><h5>
+<a name="id36190900"></a>
+ <a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.same_sign.examples.compile_time_version">Compile-time
+ version</a>
+ </h5>
+<pre class="programlisting">#include <boost/integer/same_sign.hpp>
+#include <iostream>
+
+int main()
+{
+ bool result = boost::static_same_sign<int, 2, 10>::value;
+ std::cout << result << std::endl; //true
+
+ result = boost::static_same_sign<int, 10, -2>::value;
+ std::cout << result << std::endl; // false
+}
+</pre>
+</div>
+</div>
+<div class="section" title="Sign function">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_integer.bits_and_ints.sign"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.sign" title="Sign function"> Sign function</a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="bits_and_ints.html#boost_integer.bits_and_ints.sign.run_time_version">Run-time
+ version</a></dt>
+<dt>Examples</dt>
+</dl></div>
+
+ The <code class="computeroutput">sign</code> function check the
+ signal of integrals.
+ 
+<div class="section" title="Run-time version">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer.bits_and_ints.sign.run_time_version"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.sign.run_time_version" title="Run-time version">Run-time
+ version</a>
+</h4></div></div></div>
+
+ The run-time version can be included via <boost/integer/sign.hpp>.
+ For valid types T, the function <code class="computeroutput">sign</code>
+ will be:
+ 
+<pre class="programlisting">template <typename T>
+int sign(T data);
+</pre>
+<a name="boost_integer.bits_and_ints.sign.run_time_version.parameters"></a><h5>
+<a name="id36191344"></a>
+ <a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.sign.run_time_version.parameters">Parameters</a>
+ </h5>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Parameter
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+ <code class="computeroutput">data</code>
+ 
+ </td>
+<td>
+ 
+ The data to be checked. The type of data must
+ be an integral otherwise, sign(data) will result in an error.
+ 
+ </td>
+</tr></tbody>
+</table></div>
+<a name="boost_integer.bits_and_ints.sign.run_time_version.return"></a><h5>
+<a name="id36191421"></a>
+ <a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.sign.run_time_version.return">Return</a>
+ </h5>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Value
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">-1</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">data</code> is negative.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">0</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">data</code> is equal to
+ zero.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">1</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">data</code> is positive.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="section" title="Examples">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer.bits_and_ints.sign.examples"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.sign.examples" title="Examples">Examples</a>
+</h4></div></div></div>
+<a name="boost_integer.bits_and_ints.sign.examples.run_time_version"></a><h5>
+<a name="id36191577"></a>
+ <a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.sign.examples.run_time_version">Run-time
+ version</a>
+ </h5>
+<pre class="programlisting">#include <boost/integer/sign.hpp>
+#include <iostream>
+
+int main()
+{
+ int first = -100, second = 340, third = 0;
+
+ int result = boost::sign(first);
+ std::cout << result << std::endl; // -1
+
+ result = boost::sign(second);
+ std::cout << result << std::endl; // 1
+
+ result = boost::sing(third);
+ std::cout << result << std::endl; // 0
+}
+</pre>
+</div>
+</div>
+<div class="section" title="Binary Utilities">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_integer.bits_and_ints.bin_utils"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.bin_utils" title="Binary Utilities"> Binary Utilities</a>
+</h3></div></div></div>
+
+ The header <boost/integer/bin_utils.hpp>
+ cotains some metafunctions to handle binary data. All the metafunctions have
+ an member varible named <code class="computeroutput">value</code>
+ where will be the result.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Metafuntion
+ 
+ </th>
+<th>
+ 
+ Parameters
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ set_bit
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">typename T</code>,
+ <code class="computeroutput">T data</code>,
+ <code class="computeroutput">unsigned char
+ pos</code>
+ 
+ </td>
+<td>
+ 
+ Sets the bit <code class="computeroutput">pos</code>
+ active in <code class="computeroutput">data</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ clear_bit
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">typename T</code>,
+ <code class="computeroutput">T data</code>,
+ <code class="computeroutput">unsigned char
+ pos</code>
+ 
+ </td>
+<td>
+ 
+ Sets the bit <code class="computeroutput">pos</code>
+ inactive in <code class="computeroutput">data</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ test_bit
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">typename T</code>,
+ <code class="computeroutput">T data</code>,
+ <code class="computeroutput">unsigned char
+ pos</code>
+ 
+ </td>
+<td>
+ 
+ Test if the bit <code class="computeroutput">pos</code>
+ in <code class="computeroutput">data</code> is active
+ or not.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ flip_bit
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">typename T</code>,
+ <code class="computeroutput">T data</code>,
+ <code class="computeroutput">unsigned char
+ pos</code>
+ 
+ </td>
+<td>
+ 
+ Invert the value of the bit <code class="computeroutput">pos</code>
+ in <code class="computeroutput">data</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ modify_bit
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">typename T</code>,
+ <code class="computeroutput">T data</code>,
+ <code class="computeroutput">unsigned char
+ pos</code>, <code class="computeroutput">bool
+ state</code>
+ 
+ </td>
+<td>
+ 
+ Sets the bit <code class="computeroutput">pos</code>
+ in <code class="computeroutput">data</code> active if
+ <code class="computeroutput">state</code> is <code class="computeroutput">true</code> or inactive if <code class="computeroutput">state</code> is <code class="computeroutput">false</code>.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2001 -2009 Beman Dawes, Daryle Walker, Gennaro Prota,
+ John Maddock
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="log2.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="minmax.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Date view	Thread view	Subject view	Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk