<!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/xhtml;charset=UTF-8"/>
<title>SphinxBase: include/sphinxbase/bitvec.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">SphinxBase <span id="projectnumber">0.6</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('bitvec_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#define-members">Defines</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>include/sphinxbase/bitvec.h File Reference</h1> </div>
</div>
<div class="contents">
<p>An implementation of bit vectors.
<a href="#_details">More...</a></p>
<div class="textblock"><code>#include <string.h></code><br/>
<code>#include <sphinxbase/sphinxbase_export.h></code><br/>
<code>#include <sphinxbase/prim_type.h></code><br/>
<code>#include <sphinxbase/ckd_alloc.h></code><br/>
</div>
<p><a href="bitvec_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa992f8d4c7dbe0b71bfd1e01ce279167"></a><!-- doxytag: member="bitvec.h::BITVEC_BITS" ref="aa992f8d4c7dbe0b71bfd1e01ce279167" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>BITVEC_BITS</b>   32</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1d82193826583f234a71cba32267d3f3"></a><!-- doxytag: member="bitvec.h::bitvec_size" ref="a1d82193826583f234a71cba32267d3f3" args="(n)" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="bitvec_8h.html#a1d82193826583f234a71cba32267d3f3">bitvec_size</a>(n)   (((n)+BITVEC_BITS-1)/BITVEC_BITS)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Number of bitvec_t in a bit vector. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a866043a7ac23e137f6c2f2466f4abc70"></a><!-- doxytag: member="bitvec.h::bitvec_alloc" ref="a866043a7ac23e137f6c2f2466f4abc70" args="(n)" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="bitvec_8h.html#a866043a7ac23e137f6c2f2466f4abc70">bitvec_alloc</a>(n)   ckd_calloc(bitvec_size(n), sizeof(bitvec_t))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocate a bit vector. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae53ebce7c4c616fdc601e8306aebcc4b"></a><!-- doxytag: member="bitvec.h::bitvec_realloc" ref="ae53ebce7c4c616fdc601e8306aebcc4b" args="(v, n)" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="bitvec_8h.html#ae53ebce7c4c616fdc601e8306aebcc4b">bitvec_realloc</a>(v, n)   ckd_realloc(v, bitvec_size(n) * sizeof(bitvec_t))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resize a bit vector. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5628e35c88ac7e91b99dce916758824a"></a><!-- doxytag: member="bitvec.h::bitvec_free" ref="a5628e35c88ac7e91b99dce916758824a" args="(v)" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="bitvec_8h.html#a5628e35c88ac7e91b99dce916758824a">bitvec_free</a>(v)   ckd_free(v)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Free a bit vector. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="bitvec_8h.html#ae90878b8f2316f5733d83a3f47d378ac">bitvec_set</a>(v, b)   (v[(b)/BITVEC_BITS] |= (1UL << ((b) & (BITVEC_BITS-1))))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the b-th bit of bit vector v. <a href="#ae90878b8f2316f5733d83a3f47d378ac"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="bitvec_8h.html#ab7abefb917e02790e9384d3149ff461e">bitvec_set_all</a>(v, n)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set all n bits in bit vector v. <a href="#ab7abefb917e02790e9384d3149ff461e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="bitvec_8h.html#a74b3387345ca2730a8067626878843fc">bitvec_clear</a>(v, b)   (v[(b)/BITVEC_BITS] &= ~(1UL << ((b) & (BITVEC_BITS-1))))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear the b-th bit of bit vector v. <a href="#a74b3387345ca2730a8067626878843fc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="bitvec_8h.html#a89f80d7a8040e9225f3c1c9bf102ae1d">bitvec_clear_all</a>(v, n)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear all n bits in bit vector v. <a href="#a89f80d7a8040e9225f3c1c9bf102ae1d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="bitvec_8h.html#ae323f80288b2ff946d6d8b0e38f791c9">bitvec_is_set</a>(v, b)   (v[(b)/BITVEC_BITS] & (1UL << ((b) & (BITVEC_BITS-1))))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check whether the b-th bit is set in vector v. <a href="#ae323f80288b2ff946d6d8b0e38f791c9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="bitvec_8h.html#a8154409a6e05e7c1ed7f21eff5ed06d4">bitvec_is_clear</a>(v, b)   (! (bitvec_is_set(v,b)))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check whether the b-th bit is cleared in vector v. <a href="#a8154409a6e05e7c1ed7f21eff5ed06d4"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ade0d20aa7e2ccec4e6fcf06419251f71"></a><!-- doxytag: member="bitvec.h::bitvec_t" ref="ade0d20aa7e2ccec4e6fcf06419251f71" args="" -->
typedef uint32 </td><td class="memItemRight" valign="bottom"><b>bitvec_t</b></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="bitvec_8h.html#ac8eeaf487cd029e23fffe676f9a77a10">bitvec_count_set</a> (bitvec_t *vec, size_t len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of bits set in the given bitvector. <a href="#ac8eeaf487cd029e23fffe676f9a77a10"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>An implementation of bit vectors. </p>
<p>Implementation of basic operations of bit vectors. </p>
<p>Definition in file <a class="el" href="bitvec_8h_source.html">bitvec.h</a>.</p>
</div><hr/><h2>Define Documentation</h2>
<a class="anchor" id="a74b3387345ca2730a8067626878843fc"></a><!-- doxytag: member="bitvec.h::bitvec_clear" ref="a74b3387345ca2730a8067626878843fc" args="(v, b)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define bitvec_clear</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">v, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">b </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   (v[(b)/BITVEC_BITS] &= ~(1UL << ((b) & (BITVEC_BITS-1))))</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clear the b-th bit of bit vector v. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">v</td><td>is a vector </td></tr>
<tr><td class="paramname">b</td><td>is the bit which will be set </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="bitvec_8h_source.html#l00110">110</a> of file <a class="el" href="bitvec_8h_source.html">bitvec.h</a>.</p>
</div>
</div>
<a class="anchor" id="a89f80d7a8040e9225f3c1c9bf102ae1d"></a><!-- doxytag: member="bitvec.h::bitvec_clear_all" ref="a89f80d7a8040e9225f3c1c9bf102ae1d" args="(v, n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define bitvec_clear_all</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">v, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">n </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment">memset(v, 0, (((n)+BITVEC_BITS-1)/BITVEC_BITS) * \
<span class="keyword">sizeof</span>(bitvec_t))
</pre></div>
<p>Clear all n bits in bit vector v. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">v</td><td>is a vector </td></tr>
<tr><td class="paramname">n</td><td>is the number of bits </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="bitvec_8h_source.html#l00118">118</a> of file <a class="el" href="bitvec_8h_source.html">bitvec.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8154409a6e05e7c1ed7f21eff5ed06d4"></a><!-- doxytag: member="bitvec.h::bitvec_is_clear" ref="a8154409a6e05e7c1ed7f21eff5ed06d4" args="(v, b)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define bitvec_is_clear</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">v, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">b </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   (! (bitvec_is_set(v,b)))</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check whether the b-th bit is cleared in vector v. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">v</td><td>is a vector </td></tr>
<tr><td class="paramname">b</td><td>is the bit which will be checked </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="bitvec_8h_source.html#l00135">135</a> of file <a class="el" href="bitvec_8h_source.html">bitvec.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae323f80288b2ff946d6d8b0e38f791c9"></a><!-- doxytag: member="bitvec.h::bitvec_is_set" ref="ae323f80288b2ff946d6d8b0e38f791c9" args="(v, b)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define bitvec_is_set</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">v, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">b </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   (v[(b)/BITVEC_BITS] & (1UL << ((b) & (BITVEC_BITS-1))))</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check whether the b-th bit is set in vector v. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">v</td><td>is a vector </td></tr>
<tr><td class="paramname">b</td><td>is the bit which will be checked </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="bitvec_8h_source.html#l00127">127</a> of file <a class="el" href="bitvec_8h_source.html">bitvec.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae90878b8f2316f5733d83a3f47d378ac"></a><!-- doxytag: member="bitvec.h::bitvec_set" ref="ae90878b8f2316f5733d83a3f47d378ac" args="(v, b)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define bitvec_set</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">v, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">b </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   (v[(b)/BITVEC_BITS] |= (1UL << ((b) & (BITVEC_BITS-1))))</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the b-th bit of bit vector v. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">v</td><td>is a vector </td></tr>
<tr><td class="paramname">b</td><td>is the bit which will be set </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="bitvec_8h_source.html#l00093">93</a> of file <a class="el" href="bitvec_8h_source.html">bitvec.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab7abefb917e02790e9384d3149ff461e"></a><!-- doxytag: member="bitvec.h::bitvec_set_all" ref="ab7abefb917e02790e9384d3149ff461e" args="(v, n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define bitvec_set_all</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">v, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">n </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment">memset(v, (bitvec_t)-1, \
(((n)+BITVEC_BITS-1)/BITVEC_BITS) * \
<span class="keyword">sizeof</span>(bitvec_t))
</pre></div>
<p>Set all n bits in bit vector v. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">v</td><td>is a vector </td></tr>
<tr><td class="paramname">n</td><td>is the number of bits </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="bitvec_8h_source.html#l00101">101</a> of file <a class="el" href="bitvec_8h_source.html">bitvec.h</a>.</p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ac8eeaf487cd029e23fffe676f9a77a10"></a><!-- doxytag: member="bitvec.h::bitvec_count_set" ref="ac8eeaf487cd029e23fffe676f9a77a10" args="(bitvec_t *vec, size_t len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT size_t bitvec_count_set </td>
<td>(</td>
<td class="paramtype">bitvec_t * </td>
<td class="paramname"><em>vec</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the number of bits set in the given bitvector. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">vec</td><td>is the bit vector </td></tr>
<tr><td class="paramname">len</td><td>is the length of bit vector <code>vec</code> </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the number of bits being set in vector <code>vec</code> </dd></dl>
<p>Definition at line <a class="el" href="bitvec_8c_source.html#l00064">64</a> of file <a class="el" href="bitvec_8c_source.html">bitvec.c</a>.</p>
<p>References <a class="el" href="bitvec_8c_source.html#l00064">bitvec_count_set()</a>.</p>
<p>Referenced by <a class="el" href="bitvec_8c_source.html#l00064">bitvec_count_set()</a>.</p>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="bitvec_8h.html">bitvec.h</a> </li>
<li class="footer">Generated on Tue Apr 19 2011 for SphinxBase by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
0b420d0fce195cf4115dc6a3be5c2da2
>
files
>
66
