1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Class template dynamic_bitset</title> 5<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../index.html" title="Chapter 1. Boost.Compute"> 8<link rel="up" href="../../boost_compute/reference.html#header.boost.compute.container.dynamic_bitset_hpp" title="Header <boost/compute/container/dynamic_bitset.hpp>"> 9<link rel="prev" href="basic_string.html" title="Class template basic_string"> 10<link rel="next" href="flat_map.html" title="Class template flat_map"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> 15<td align="center"><a href="../../../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="basic_string.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.container.dynamic_bitset_hpp"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="flat_map.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="refentry"> 26<a name="boost.compute.dynamic_bitset"></a><div class="titlepage"></div> 27<div class="refnamediv"> 28<h2><span class="refentrytitle">Class template dynamic_bitset</span></h2> 29<p>boost::compute::dynamic_bitset — The <a class="link" href="dynamic_bitset.html" title="Class template dynamic_bitset">dynamic_bitset</a> class contains a resizable bit array. </p> 30</div> 31<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> 32<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../boost_compute/reference.html#header.boost.compute.container.dynamic_bitset_hpp" title="Header <boost/compute/container/dynamic_bitset.hpp>">boost/compute/container/dynamic_bitset.hpp</a>> 33 34</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Block <span class="special">=</span> <span class="identifier">ulong_</span><span class="special">,</span> <span class="keyword">typename</span> Alloc <span class="special">=</span> <a class="link" href="buffer_allocator.html" title="Class template buffer_allocator">buffer_allocator</a><span class="special"><</span><span class="identifier">Block</span><span class="special">></span> <span class="special">></span> 35<span class="keyword">class</span> <a class="link" href="dynamic_bitset.html" title="Class template dynamic_bitset">dynamic_bitset</a> <span class="special">{</span> 36<span class="keyword">public</span><span class="special">:</span> 37 <span class="comment">// types</span> 38 <span class="keyword">typedef</span> <span class="identifier">Block</span> <a name="boost.compute.dynamic_bitset.block_type"></a><span class="identifier">block_type</span><span class="special">;</span> 39 <span class="keyword">typedef</span> <span class="identifier">Alloc</span> <a name="boost.compute.dynamic_bitset.allocator_type"></a><span class="identifier">allocator_type</span><span class="special">;</span> 40 <span class="keyword">typedef</span> <a class="link" href="vector.html" title="Class template vector">vector</a><span class="special"><</span> <span class="identifier">Block</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <a name="boost.compute.dynamic_bitset.container_type"></a><span class="identifier">container_type</span><span class="special">;</span> 41 <span class="keyword">typedef</span> <span class="identifier">container_type</span><span class="special">::</span><span class="identifier">size_type</span> <a name="boost.compute.dynamic_bitset.size_type"></a><span class="identifier">size_type</span><span class="special">;</span> 42 43 <span class="comment">// <a class="link" href="dynamic_bitset.html#boost.compute.dynamic_bitsetconstruct-copy-destruct">construct/copy/destruct</a></span> 44 <a class="link" href="dynamic_bitset.html#idm45549386114368-bb"><span class="identifier">dynamic_bitset</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 45 <a class="link" href="dynamic_bitset.html#idm45549386111792-bb"><span class="identifier">dynamic_bitset</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="dynamic_bitset.html" title="Class template dynamic_bitset">dynamic_bitset</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 46 <a class="link" href="dynamic_bitset.html" title="Class template dynamic_bitset">dynamic_bitset</a> <span class="special">&</span> <a class="link" href="dynamic_bitset.html#idm45549386109600-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="dynamic_bitset.html" title="Class template dynamic_bitset">dynamic_bitset</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 47 <a class="link" href="dynamic_bitset.html#idm45549386106416-bb"><span class="special">~</span><span class="identifier">dynamic_bitset</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 48 49 <span class="comment">// <a class="link" href="dynamic_bitset.html#idm45549386159232-bb">public member functions</a></span> 50 <a class="link" href="dynamic_bitset.html#idm45549386158672-bb"><span class="identifier">BOOST_STATIC_CONSTANT</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> 51 <span class="identifier">bits_per_block</span> <span class="special">=</span> <span class="keyword">sizeof</span><span class="special">(</span><span class="identifier">block_type</span><span class="special">)</span> <span class="special">*</span><span class="identifier">CHAR_BIT</span><span class="special">)</span><span class="special">;</span> 52 <a class="link" href="dynamic_bitset.html#idm45549386156304-bb"><span class="identifier">BOOST_STATIC_CONSTANT</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">npos</span> <span class="special">=</span> <span class="keyword">static_cast</span><span class="special"><</span> <span class="identifier">size_type</span> <span class="special">></span><span class="special">(</span><span class="special">-</span><span class="number">1</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> 53 <span class="identifier">size_type</span> <a class="link" href="dynamic_bitset.html#idm45549386153936-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 54 <span class="identifier">size_type</span> <a class="link" href="dynamic_bitset.html#idm45549386152496-bb"><span class="identifier">num_blocks</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 55 <span class="identifier">size_type</span> <a class="link" href="dynamic_bitset.html#idm45549386151040-bb"><span class="identifier">max_size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 56 <span class="keyword">bool</span> <a class="link" href="dynamic_bitset.html#idm45549386149584-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 57 <span class="identifier">size_type</span> <a class="link" href="dynamic_bitset.html#idm45549386146816-bb"><span class="identifier">count</span></a><span class="special">(</span><span class="identifier">command_queue</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 58 <span class="keyword">void</span> <a class="link" href="dynamic_bitset.html#idm45549386144672-bb"><span class="identifier">resize</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 59 <span class="keyword">void</span> <a class="link" href="dynamic_bitset.html#idm45549386141504-bb"><span class="identifier">set</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 60 <span class="keyword">void</span> <a class="link" href="dynamic_bitset.html#idm45549386138080-bb"><span class="identifier">set</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 61 <span class="keyword">bool</span> <a class="link" href="dynamic_bitset.html#idm45549386133968-bb"><span class="identifier">test</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 62 <span class="keyword">void</span> <a class="link" href="dynamic_bitset.html#idm45549386130544-bb"><span class="identifier">flip</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 63 <span class="keyword">bool</span> <a class="link" href="dynamic_bitset.html#idm45549386127568-bb"><span class="identifier">any</span></a><span class="special">(</span><span class="identifier">command_queue</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 64 <span class="keyword">bool</span> <a class="link" href="dynamic_bitset.html#idm45549386124992-bb"><span class="identifier">none</span></a><span class="special">(</span><span class="identifier">command_queue</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 65 <span class="keyword">void</span> <a class="link" href="dynamic_bitset.html#idm45549386122416-bb"><span class="identifier">reset</span></a><span class="special">(</span><span class="identifier">command_queue</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 66 <span class="keyword">void</span> <a class="link" href="dynamic_bitset.html#idm45549386120560-bb"><span class="identifier">reset</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 67 <span class="keyword">void</span> <a class="link" href="dynamic_bitset.html#idm45549386117584-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 68 <span class="identifier">allocator_type</span> <a class="link" href="dynamic_bitset.html#idm45549386115984-bb"><span class="identifier">get_allocator</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 69<span class="special">}</span><span class="special">;</span></pre></div> 70<div class="refsect1"> 71<a name="idm45849515943280"></a><h2>Description</h2> 72<p>For example, to create a dynamic-bitset with space for 1000 bits on the device: </p> 73<pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">compute</span><span class="special">::</span><span class="identifier">dynamic_bitset</span><span class="special"><</span><span class="special">></span> <span class="identifier">bits</span><span class="special">(</span><span class="number">1000</span><span class="special">,</span> <span class="identifier">queue</span><span class="special">)</span><span class="special">;</span> 74</pre> 75<p>The Boost.Compute <code class="computeroutput"><a class="link" href="dynamic_bitset.html" title="Class template dynamic_bitset">dynamic_bitset</a></code> class provides a STL-like API and is modeled after the <code class="computeroutput">boost::dynamic_bitset</code> class from Boost.</p> 76<p><span class="bold"><strong>See Also:</strong></span></p> 77<p><a class="link" href="vector.html" title="Class template vector">vector<T></a> </p> 78<p> 79</p> 80<p> 81</p> 82<div class="refsect2"> 83<a name="idm45849515929760"></a><h3> 84<a name="boost.compute.dynamic_bitsetconstruct-copy-destruct"></a><code class="computeroutput">dynamic_bitset</code> 85 public 86 construct/copy/destruct</h3> 87<div class="orderedlist"><ol class="orderedlist" type="1"> 88<li class="listitem"> 89<pre class="literallayout"><a name="idm45549386114368-bb"></a><span class="identifier">dynamic_bitset</span><span class="special">(</span><span class="identifier">size_type</span> size<span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&</span> queue<span class="special">)</span><span class="special">;</span></pre> 90<p>Creates a new dynamic bitset with storage for <code class="computeroutput">size</code> bits. Initializes all bits to zero. </p> 91</li> 92<li class="listitem"> 93<pre class="literallayout"><a name="idm45549386111792-bb"></a><span class="identifier">dynamic_bitset</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="dynamic_bitset.html" title="Class template dynamic_bitset">dynamic_bitset</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre>Creates a new dynamic bitset as a copy of <code class="computeroutput">other</code>. </li> 94<li class="listitem"> 95<pre class="literallayout"><a class="link" href="dynamic_bitset.html" title="Class template dynamic_bitset">dynamic_bitset</a> <span class="special">&</span> <a name="idm45549386109600-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="dynamic_bitset.html" title="Class template dynamic_bitset">dynamic_bitset</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre>Copies the data from <code class="computeroutput">other</code> to <code class="computeroutput">*this</code>. </li> 96<li class="listitem"> 97<pre class="literallayout"><a name="idm45549386106416-bb"></a><span class="special">~</span><span class="identifier">dynamic_bitset</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destroys the dynamic bitset. </li> 98</ol></div> 99</div> 100<div class="refsect2"> 101<a name="idm45849515899536"></a><h3> 102<a name="idm45549386159232-bb"></a><code class="computeroutput">dynamic_bitset</code> public member functions</h3> 103<div class="orderedlist"><ol class="orderedlist" type="1"> 104<li class="listitem"><pre class="literallayout"> <a name="idm45549386158672-bb"></a><span class="identifier">BOOST_STATIC_CONSTANT</span><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> 105 <span class="identifier">bits_per_block</span> <span class="special">=</span> <span class="keyword">sizeof</span><span class="special">(</span><span class="identifier">block_type</span><span class="special">)</span> <span class="special">*</span><span class="identifier">CHAR_BIT</span><span class="special">)</span><span class="special">;</span></pre></li> 106<li class="listitem"><pre class="literallayout"> <a name="idm45549386156304-bb"></a><span class="identifier">BOOST_STATIC_CONSTANT</span><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">npos</span> <span class="special">=</span> <span class="keyword">static_cast</span><span class="special"><</span> <span class="identifier">size_type</span> <span class="special">></span><span class="special">(</span><span class="special">-</span><span class="number">1</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></li> 107<li class="listitem"> 108<pre class="literallayout"><span class="identifier">size_type</span> <a name="idm45549386153936-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the size of the dynamic bitset. </li> 109<li class="listitem"> 110<pre class="literallayout"><span class="identifier">size_type</span> <a name="idm45549386152496-bb"></a><span class="identifier">num_blocks</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the number of blocks to store the bits in the dynamic bitset. </li> 111<li class="listitem"> 112<pre class="literallayout"><span class="identifier">size_type</span> <a name="idm45549386151040-bb"></a><span class="identifier">max_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the maximum possible size for the dynamic bitset. </li> 113<li class="listitem"> 114<pre class="literallayout"><span class="keyword">bool</span> <a name="idm45549386149584-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns <code class="computeroutput">true</code> if the dynamic bitset is empty (i.e. <code class="computeroutput">size()</code> == <code class="computeroutput">0</code>). </li> 115<li class="listitem"> 116<pre class="literallayout"><span class="identifier">size_type</span> <a name="idm45549386146816-bb"></a><span class="identifier">count</span><span class="special">(</span><span class="identifier">command_queue</span> <span class="special">&</span> queue<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the number of set bits (i.e. '1') in the bitset. </li> 117<li class="listitem"> 118<pre class="literallayout"><span class="keyword">void</span> <a name="idm45549386144672-bb"></a><span class="identifier">resize</span><span class="special">(</span><span class="identifier">size_type</span> num_bits<span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&</span> queue<span class="special">)</span><span class="special">;</span></pre> 119<p>Resizes the bitset to contain <code class="computeroutput">num_bits</code>. If the new size is greater than the current size the new bits are set to zero. </p> 120</li> 121<li class="listitem"> 122<pre class="literallayout"><span class="keyword">void</span> <a name="idm45549386141504-bb"></a><span class="identifier">set</span><span class="special">(</span><span class="identifier">size_type</span> n<span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&</span> queue<span class="special">)</span><span class="special">;</span></pre>Sets the bit at position <code class="computeroutput">n</code> to <code class="computeroutput">true</code>. </li> 123<li class="listitem"> 124<pre class="literallayout"><span class="keyword">void</span> <a name="idm45549386138080-bb"></a><span class="identifier">set</span><span class="special">(</span><span class="identifier">size_type</span> n<span class="special">,</span> <span class="keyword">bool</span> value<span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&</span> queue<span class="special">)</span><span class="special">;</span></pre>Sets the bit at position <code class="computeroutput">n</code> to <code class="computeroutput">value</code>. </li> 125<li class="listitem"> 126<pre class="literallayout"><span class="keyword">bool</span> <a name="idm45549386133968-bb"></a><span class="identifier">test</span><span class="special">(</span><span class="identifier">size_type</span> n<span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&</span> queue<span class="special">)</span><span class="special">;</span></pre>Returns <code class="computeroutput">true</code> if the bit at position <code class="computeroutput">n</code> is set (i.e. '1'). </li> 127<li class="listitem"> 128<pre class="literallayout"><span class="keyword">void</span> <a name="idm45549386130544-bb"></a><span class="identifier">flip</span><span class="special">(</span><span class="identifier">size_type</span> n<span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&</span> queue<span class="special">)</span><span class="special">;</span></pre>Flips the value of the bit at position <code class="computeroutput">n</code>. </li> 129<li class="listitem"> 130<pre class="literallayout"><span class="keyword">bool</span> <a name="idm45549386127568-bb"></a><span class="identifier">any</span><span class="special">(</span><span class="identifier">command_queue</span> <span class="special">&</span> queue<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns <code class="computeroutput">true</code> if any bit in the bitset is set (i.e. '1'). </li> 131<li class="listitem"> 132<pre class="literallayout"><span class="keyword">bool</span> <a name="idm45549386124992-bb"></a><span class="identifier">none</span><span class="special">(</span><span class="identifier">command_queue</span> <span class="special">&</span> queue<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns <code class="computeroutput">true</code> if all of the bits in the bitset are set to zero. </li> 133<li class="listitem"> 134<pre class="literallayout"><span class="keyword">void</span> <a name="idm45549386122416-bb"></a><span class="identifier">reset</span><span class="special">(</span><span class="identifier">command_queue</span> <span class="special">&</span> queue<span class="special">)</span><span class="special">;</span></pre>Sets all of the bits in the bitset to zero. </li> 135<li class="listitem"> 136<pre class="literallayout"><span class="keyword">void</span> <a name="idm45549386120560-bb"></a><span class="identifier">reset</span><span class="special">(</span><span class="identifier">size_type</span> n<span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&</span> queue<span class="special">)</span><span class="special">;</span></pre>Sets the bit at position <code class="computeroutput">n</code> to zero. </li> 137<li class="listitem"> 138<pre class="literallayout"><span class="keyword">void</span> <a name="idm45549386117584-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Empties the bitset (e.g. <code class="computeroutput">resize(0)</code>). </li> 139<li class="listitem"> 140<pre class="literallayout"><span class="identifier">allocator_type</span> <a name="idm45549386115984-bb"></a><span class="identifier">get_allocator</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the allocator used to allocate storage for the bitset. </li> 141</ol></div> 142</div> 143</div> 144</div> 145<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 146<td align="left"></td> 147<td align="right"><div class="copyright-footer">Copyright © 2013, 2014 Kyle Lutz<p> 148 Distributed under the Boost Software License, Version 1.0. (See accompanying 149 file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) 150 </p> 151</div></td> 152</tr></table> 153<hr> 154<div class="spirit-nav"> 155<a accesskey="p" href="basic_string.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.container.dynamic_bitset_hpp"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="flat_map.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 156</div> 157</body> 158</html> 159
