<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.8"/> <title>SphinxBase: include/sphinxbase/bitvec.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); $(window).load(resizeHeight); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <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> <!-- end header part --> <!-- Generated by Doxygen 1.8.8 --> <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><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('bitvec_8h.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#define-members">Macros</a> | <a href="#typedef-members">Typedefs</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">bitvec.h File Reference</div> </div> </div><!--header--> <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 <<a class="el" href="prim__type_8h_source.html">sphinxbase/prim_type.h</a>></code><br /> <code>#include <<a class="el" href="ckd__alloc_8h_source.html">sphinxbase/ckd_alloc.h</a>></code><br /> </div> <p><a href="bitvec_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> Macros</h2></td></tr> <tr class="memitem:aa992f8d4c7dbe0b71bfd1e01ce279167"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa992f8d4c7dbe0b71bfd1e01ce279167"></a> #define </td><td class="memItemRight" valign="bottom"><b>BITVEC_BITS</b>   32</td></tr> <tr class="separator:aa992f8d4c7dbe0b71bfd1e01ce279167"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1d82193826583f234a71cba32267d3f3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1d82193826583f234a71cba32267d3f3"></a> #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 class="memdesc:a1d82193826583f234a71cba32267d3f3"><td class="mdescLeft"> </td><td class="mdescRight">Number of bitvec_t in a bit vector. <br /></td></tr> <tr class="separator:a1d82193826583f234a71cba32267d3f3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a866043a7ac23e137f6c2f2466f4abc70"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a866043a7ac23e137f6c2f2466f4abc70"></a> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="bitvec_8h.html#a866043a7ac23e137f6c2f2466f4abc70">bitvec_alloc</a>(n)   <a class="el" href="ckd__alloc_8h.html#aa00ef21903bc4f8a972488417adc8d2e">ckd_calloc</a>(<a class="el" href="bitvec_8h.html#a1d82193826583f234a71cba32267d3f3">bitvec_size</a>(n), sizeof(bitvec_t))</td></tr> <tr class="memdesc:a866043a7ac23e137f6c2f2466f4abc70"><td class="mdescLeft"> </td><td class="mdescRight">Allocate a bit vector, all bits are clear. <br /></td></tr> <tr class="separator:a866043a7ac23e137f6c2f2466f4abc70"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5628e35c88ac7e91b99dce916758824a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5628e35c88ac7e91b99dce916758824a"></a> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="bitvec_8h.html#a5628e35c88ac7e91b99dce916758824a">bitvec_free</a>(v)   <a class="el" href="ckd__alloc_8h.html#a31c6b405558620ac37599737b5722fbf">ckd_free</a>(v)</td></tr> <tr class="memdesc:a5628e35c88ac7e91b99dce916758824a"><td class="mdescLeft"> </td><td class="mdescRight">Free a bit vector. <br /></td></tr> <tr class="separator:a5628e35c88ac7e91b99dce916758824a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae90878b8f2316f5733d83a3f47d378ac"><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 class="memdesc:ae90878b8f2316f5733d83a3f47d378ac"><td class="mdescLeft"> </td><td class="mdescRight">Set the b-th bit of bit vector v. <a href="#ae90878b8f2316f5733d83a3f47d378ac">More...</a><br /></td></tr> <tr class="separator:ae90878b8f2316f5733d83a3f47d378ac"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab7abefb917e02790e9384d3149ff461e"><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 class="memdesc:ab7abefb917e02790e9384d3149ff461e"><td class="mdescLeft"> </td><td class="mdescRight">Set all n bits in bit vector v. <a href="#ab7abefb917e02790e9384d3149ff461e">More...</a><br /></td></tr> <tr class="separator:ab7abefb917e02790e9384d3149ff461e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a74b3387345ca2730a8067626878843fc"><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 class="memdesc:a74b3387345ca2730a8067626878843fc"><td class="mdescLeft"> </td><td class="mdescRight">Clear the b-th bit of bit vector v. <a href="#a74b3387345ca2730a8067626878843fc">More...</a><br /></td></tr> <tr class="separator:a74b3387345ca2730a8067626878843fc"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a89f80d7a8040e9225f3c1c9bf102ae1d"><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 class="memdesc:a89f80d7a8040e9225f3c1c9bf102ae1d"><td class="mdescLeft"> </td><td class="mdescRight">Clear all n bits in bit vector v. <a href="#a89f80d7a8040e9225f3c1c9bf102ae1d">More...</a><br /></td></tr> <tr class="separator:a89f80d7a8040e9225f3c1c9bf102ae1d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae323f80288b2ff946d6d8b0e38f791c9"><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 class="memdesc:ae323f80288b2ff946d6d8b0e38f791c9"><td class="mdescLeft"> </td><td class="mdescRight">Check whether the b-th bit is set in vector v. <a href="#ae323f80288b2ff946d6d8b0e38f791c9">More...</a><br /></td></tr> <tr class="separator:ae323f80288b2ff946d6d8b0e38f791c9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8154409a6e05e7c1ed7f21eff5ed06d4"><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)   (! (<a class="el" href="bitvec_8h.html#ae323f80288b2ff946d6d8b0e38f791c9">bitvec_is_set</a>(v,b)))</td></tr> <tr class="memdesc:a8154409a6e05e7c1ed7f21eff5ed06d4"><td class="mdescLeft"> </td><td class="mdescRight">Check whether the b-th bit is cleared in vector v. <a href="#a8154409a6e05e7c1ed7f21eff5ed06d4">More...</a><br /></td></tr> <tr class="separator:a8154409a6e05e7c1ed7f21eff5ed06d4"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> Typedefs</h2></td></tr> <tr class="memitem:ade0d20aa7e2ccec4e6fcf06419251f71"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ade0d20aa7e2ccec4e6fcf06419251f71"></a> typedef uint32 </td><td class="memItemRight" valign="bottom"><b>bitvec_t</b></td></tr> <tr class="separator:ade0d20aa7e2ccec4e6fcf06419251f71"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:a617e9fca97ca02a5e959f989c5c1a4e4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a617e9fca97ca02a5e959f989c5c1a4e4"></a> SPHINXBASE_EXPORT bitvec_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="bitvec_8h.html#a617e9fca97ca02a5e959f989c5c1a4e4">bitvec_realloc</a> (bitvec_t *vec, size_t old_len, size_t new_len)</td></tr> <tr class="memdesc:a617e9fca97ca02a5e959f989c5c1a4e4"><td class="mdescLeft"> </td><td class="mdescRight">Resize a bit vector, clear the remaining bits. <br /></td></tr> <tr class="separator:a617e9fca97ca02a5e959f989c5c1a4e4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac8eeaf487cd029e23fffe676f9a77a10"><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 class="memdesc:ac8eeaf487cd029e23fffe676f9a77a10"><td class="mdescLeft"> </td><td class="mdescRight">Return the number of bits set in the given bitvector. <a href="#ac8eeaf487cd029e23fffe676f9a77a10">More...</a><br /></td></tr> <tr class="separator:ac8eeaf487cd029e23fffe676f9a77a10"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">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><h2 class="groupheader">Macro Definition Documentation</h2> <a class="anchor" id="a74b3387345ca2730a8067626878843fc"></a> <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 class="params"><dt>Parameters</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#l00112">112</a> of file <a class="el" href="bitvec_8h_source.html">bitvec.h</a>.</p> </div> </div> <a class="anchor" id="a89f80d7a8040e9225f3c1c9bf102ae1d"></a> <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"><div class="line">memset(v, 0, (((n)+BITVEC_BITS-1)/BITVEC_BITS) * \</div> <div class="line"> <span class="keyword">sizeof</span>(bitvec_t))</div> </div><!-- fragment --> <p>Clear all n bits in bit vector v. </p> <dl class="params"><dt>Parameters</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#l00120">120</a> of file <a class="el" href="bitvec_8h_source.html">bitvec.h</a>.</p> </div> </div> <a class="anchor" id="a8154409a6e05e7c1ed7f21eff5ed06d4"></a> <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>   (! (<a class="el" href="bitvec_8h.html#ae323f80288b2ff946d6d8b0e38f791c9">bitvec_is_set</a>(v,b)))</td> </tr> </table> </div><div class="memdoc"> <p>Check whether the b-th bit is cleared in vector v. </p> <dl class="params"><dt>Parameters</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#l00137">137</a> of file <a class="el" href="bitvec_8h_source.html">bitvec.h</a>.</p> </div> </div> <a class="anchor" id="ae323f80288b2ff946d6d8b0e38f791c9"></a> <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 class="params"><dt>Parameters</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#l00129">129</a> of file <a class="el" href="bitvec_8h_source.html">bitvec.h</a>.</p> </div> </div> <a class="anchor" id="ae90878b8f2316f5733d83a3f47d378ac"></a> <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 class="params"><dt>Parameters</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#l00095">95</a> of file <a class="el" href="bitvec_8h_source.html">bitvec.h</a>.</p> </div> </div> <a class="anchor" id="ab7abefb917e02790e9384d3149ff461e"></a> <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"><div class="line">memset(v, (bitvec_t)-1, \</div> <div class="line"> (((n)+BITVEC_BITS-1)/BITVEC_BITS) * \</div> <div class="line"> <span class="keyword">sizeof</span>(bitvec_t))</div> </div><!-- fragment --> <p>Set all n bits in bit vector v. </p> <dl class="params"><dt>Parameters</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#l00103">103</a> of file <a class="el" href="bitvec_8h_source.html">bitvec.h</a>.</p> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="ac8eeaf487cd029e23fffe676f9a77a10"></a> <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 class="params"><dt>Parameters</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="section return"><dt>Returns</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#l00080">80</a> of file <a class="el" href="bitvec_8c_source.html">bitvec.c</a>.</p> </div> </div> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_e3d154c296a8e9be2797a4f81e9375b2.html">sphinxbase</a></li><li class="navelem"><a class="el" href="bitvec_8h.html">bitvec.h</a></li> <li class="footer">Generated on Sat Oct 18 2014 15:21:17 for SphinxBase by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.8 </li> </ul> </div> </body> </html>