%PDF- %PDF-
Direktori : /proc/self/root/usr/share/nagios/html/docs/ |
Current File : //proc/self/root/usr/share/nagios/html/docs/bitmap_8h.html |
<!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.5"/> <title>Nagios: bitmap.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="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </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">Nagios  <span id="projectnumber">4.4.3</span> </div> <div id="projectbrief">Dev docs for Nagios core and neb-module hackers</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <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> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </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> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Pages</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_97aefd0d527b934f1d99a682da8fe6a9.html">lib</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">bitmap.h File Reference</div> </div> </div><!--header--> <div class="contents"> <p>Bit map API. <a href="#details">More...</a></p> <p><a href="bitmap_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> <tr class="memitem:ad57facf8258fd4874894e3c9ffce6fed"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad57facf8258fd4874894e3c9ffce6fed"></a> #define </td><td class="memItemRight" valign="bottom"><b>bitmap_size</b>   <a class="el" href="bitmap_8h.html#a29975ed2f9842ae16eb2b56d3dde62cb">bitmap_cardinality</a></td></tr> <tr class="separator:ad57facf8258fd4874894e3c9ffce6fed"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4f7a61a8684d8ec6e44f9c134f9217bc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4f7a61a8684d8ec6e44f9c134f9217bc"></a> typedef struct bitmap </td><td class="memItemRight" valign="bottom"><b>bitmap</b></td></tr> <tr class="separator:a4f7a61a8684d8ec6e44f9c134f9217bc"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a320b74f09439cec263cb75097d404ef6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="bitmap_8h.html#a320b74f09439cec263cb75097d404ef6">bitmap_resize</a> (bitmap *bm, unsigned long size)</td></tr> <tr class="memdesc:a320b74f09439cec263cb75097d404ef6"><td class="mdescLeft"> </td><td class="mdescRight">Resize a bitmap If the bitmap is made smaller, data will silently be lost. <a href="#a320b74f09439cec263cb75097d404ef6">More...</a><br/></td></tr> <tr class="separator:a320b74f09439cec263cb75097d404ef6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9001629114e98185f3de713bc128db79"><td class="memItemLeft" align="right" valign="top">bitmap * </td><td class="memItemRight" valign="bottom"><a class="el" href="bitmap_8h.html#a9001629114e98185f3de713bc128db79">bitmap_create</a> (unsigned long size)</td></tr> <tr class="memdesc:a9001629114e98185f3de713bc128db79"><td class="mdescLeft"> </td><td class="mdescRight">Create a bitmaptor of size 'size'. <a href="#a9001629114e98185f3de713bc128db79">More...</a><br/></td></tr> <tr class="separator:a9001629114e98185f3de713bc128db79"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a58ee6def2e0c32c5da45523cd446eefe"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="bitmap_8h.html#a58ee6def2e0c32c5da45523cd446eefe">bitmap_destroy</a> (bitmap *bm)</td></tr> <tr class="memdesc:a58ee6def2e0c32c5da45523cd446eefe"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a bitmaptor by freeing all the memory it uses. <a href="#a58ee6def2e0c32c5da45523cd446eefe">More...</a><br/></td></tr> <tr class="separator:a58ee6def2e0c32c5da45523cd446eefe"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af5789a6348bf94b3b47d82717dc76cbc"><td class="memItemLeft" align="right" valign="top">bitmap * </td><td class="memItemRight" valign="bottom"><a class="el" href="bitmap_8h.html#af5789a6348bf94b3b47d82717dc76cbc">bitmap_copy</a> (const bitmap *bm)</td></tr> <tr class="memdesc:af5789a6348bf94b3b47d82717dc76cbc"><td class="mdescLeft"> </td><td class="mdescRight">Copy a bitmaptor. <a href="#af5789a6348bf94b3b47d82717dc76cbc">More...</a><br/></td></tr> <tr class="separator:af5789a6348bf94b3b47d82717dc76cbc"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7543817ea7a0f3ab5564470854face7f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="bitmap_8h.html#a7543817ea7a0f3ab5564470854face7f">bitmap_set</a> (bitmap *bm, unsigned long pos)</td></tr> <tr class="memdesc:a7543817ea7a0f3ab5564470854face7f"><td class="mdescLeft"> </td><td class="mdescRight">Set a bit in the map. <a href="#a7543817ea7a0f3ab5564470854face7f">More...</a><br/></td></tr> <tr class="separator:a7543817ea7a0f3ab5564470854face7f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ade96a1d41217133b0a126269a425f43c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="bitmap_8h.html#ade96a1d41217133b0a126269a425f43c">bitmap_isset</a> (const bitmap *bm, unsigned long pos)</td></tr> <tr class="memdesc:ade96a1d41217133b0a126269a425f43c"><td class="mdescLeft"> </td><td class="mdescRight">Check if a particular bit is set in the map. <a href="#ade96a1d41217133b0a126269a425f43c">More...</a><br/></td></tr> <tr class="separator:ade96a1d41217133b0a126269a425f43c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7adb33826e021cfda5718653a92585cc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="bitmap_8h.html#a7adb33826e021cfda5718653a92585cc">bitmap_unset</a> (bitmap *bm, unsigned long pos)</td></tr> <tr class="memdesc:a7adb33826e021cfda5718653a92585cc"><td class="mdescLeft"> </td><td class="mdescRight">Unset a particular bit in the map. <a href="#a7adb33826e021cfda5718653a92585cc">More...</a><br/></td></tr> <tr class="separator:a7adb33826e021cfda5718653a92585cc"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a29975ed2f9842ae16eb2b56d3dde62cb"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="bitmap_8h.html#a29975ed2f9842ae16eb2b56d3dde62cb">bitmap_cardinality</a> (const bitmap *bm)</td></tr> <tr class="memdesc:a29975ed2f9842ae16eb2b56d3dde62cb"><td class="mdescLeft"> </td><td class="mdescRight">Obtain cardinality (max number of elements) of the bitmaptor. <a href="#a29975ed2f9842ae16eb2b56d3dde62cb">More...</a><br/></td></tr> <tr class="separator:a29975ed2f9842ae16eb2b56d3dde62cb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a36b34f5fe906fb8de09859f10ebbc12e"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="bitmap_8h.html#a36b34f5fe906fb8de09859f10ebbc12e">bitmap_count_set_bits</a> (const bitmap *bm)</td></tr> <tr class="memdesc:a36b34f5fe906fb8de09859f10ebbc12e"><td class="mdescLeft"> </td><td class="mdescRight">Count set bits in map. <a href="#a36b34f5fe906fb8de09859f10ebbc12e">More...</a><br/></td></tr> <tr class="separator:a36b34f5fe906fb8de09859f10ebbc12e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a88fdad890d533243f692584f966ddb71"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="bitmap_8h.html#a88fdad890d533243f692584f966ddb71">bitmap_count_unset_bits</a> (const bitmap *bm)</td></tr> <tr class="memdesc:a88fdad890d533243f692584f966ddb71"><td class="mdescLeft"> </td><td class="mdescRight">Count unset bits in map. <a href="#a88fdad890d533243f692584f966ddb71">More...</a><br/></td></tr> <tr class="separator:a88fdad890d533243f692584f966ddb71"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a621e8f4bbc3401e6f833f5a3df904a66"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="bitmap_8h.html#a621e8f4bbc3401e6f833f5a3df904a66">bitmap_clear</a> (bitmap *bm)</td></tr> <tr class="memdesc:a621e8f4bbc3401e6f833f5a3df904a66"><td class="mdescLeft"> </td><td class="mdescRight">Unset all bits in a bitmap. <a href="#a621e8f4bbc3401e6f833f5a3df904a66">More...</a><br/></td></tr> <tr class="separator:a621e8f4bbc3401e6f833f5a3df904a66"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3f3798a3c5b83114a16ad3225e695300"><td class="memItemLeft" align="right" valign="top">bitmap * </td><td class="memItemRight" valign="bottom"><a class="el" href="bitmap_8h.html#a3f3798a3c5b83114a16ad3225e695300">bitmap_intersect</a> (const bitmap *a, const bitmap *b)</td></tr> <tr class="memdesc:a3f3798a3c5b83114a16ad3225e695300"><td class="mdescLeft"> </td><td class="mdescRight">Calculate intersection of two bitmaps The intersection is defined as all bits that are members of both A and B. <a href="#a3f3798a3c5b83114a16ad3225e695300">More...</a><br/></td></tr> <tr class="separator:a3f3798a3c5b83114a16ad3225e695300"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae7912606995b5bd22452f23b843f0cd3"><td class="memItemLeft" align="right" valign="top">bitmap * </td><td class="memItemRight" valign="bottom"><a class="el" href="bitmap_8h.html#ae7912606995b5bd22452f23b843f0cd3">bitmap_union</a> (const bitmap *a, const bitmap *b)</td></tr> <tr class="memdesc:ae7912606995b5bd22452f23b843f0cd3"><td class="mdescLeft"> </td><td class="mdescRight">Calculate union of two bitmaps The union is defined as all bits that are members of A or B or both A and B. <a href="#ae7912606995b5bd22452f23b843f0cd3">More...</a><br/></td></tr> <tr class="separator:ae7912606995b5bd22452f23b843f0cd3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6398726cbb15e5bcc3a1a20c09a1d620"><td class="memItemLeft" align="right" valign="top">bitmap * </td><td class="memItemRight" valign="bottom"><a class="el" href="bitmap_8h.html#a6398726cbb15e5bcc3a1a20c09a1d620">bitmap_unite</a> (bitmap *res, const bitmap *addme)</td></tr> <tr class="memdesc:a6398726cbb15e5bcc3a1a20c09a1d620"><td class="mdescLeft"> </td><td class="mdescRight">Calculate union of two bitmaps and store result in one of them. <a href="#a6398726cbb15e5bcc3a1a20c09a1d620">More...</a><br/></td></tr> <tr class="separator:a6398726cbb15e5bcc3a1a20c09a1d620"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5cc918f8a86d7ed60b99972deed2f9c1"><td class="memItemLeft" align="right" valign="top">bitmap * </td><td class="memItemRight" valign="bottom"><a class="el" href="bitmap_8h.html#a5cc918f8a86d7ed60b99972deed2f9c1">bitmap_diff</a> (const bitmap *a, const bitmap *b)</td></tr> <tr class="memdesc:a5cc918f8a86d7ed60b99972deed2f9c1"><td class="mdescLeft"> </td><td class="mdescRight">Calculate set difference between two bitmaps The set difference of A / B is defined as all members of A that isn't members of B. <a href="#a5cc918f8a86d7ed60b99972deed2f9c1">More...</a><br/></td></tr> <tr class="separator:a5cc918f8a86d7ed60b99972deed2f9c1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab19ee1287ef544fc2720da707d8994af"><td class="memItemLeft" align="right" valign="top">bitmap * </td><td class="memItemRight" valign="bottom"><a class="el" href="bitmap_8h.html#ab19ee1287ef544fc2720da707d8994af">bitmap_symdiff</a> (const bitmap *a, const bitmap *b)</td></tr> <tr class="memdesc:ab19ee1287ef544fc2720da707d8994af"><td class="mdescLeft"> </td><td class="mdescRight">Calculate symmetric difference between two bitmaps The symmetric difference between A and B is the set that contains all elements in either set but not in both. <a href="#ab19ee1287ef544fc2720da707d8994af">More...</a><br/></td></tr> <tr class="separator:ab19ee1287ef544fc2720da707d8994af"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae8bd899daf6b1f890d6cc54f97f2cce0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="bitmap_8h.html#ae8bd899daf6b1f890d6cc54f97f2cce0">bitmap_cmp</a> (const bitmap *a, const bitmap *b)</td></tr> <tr class="memdesc:ae8bd899daf6b1f890d6cc54f97f2cce0"><td class="mdescLeft"> </td><td class="mdescRight">Compare two bitmaps for equality. <a href="#ae8bd899daf6b1f890d6cc54f97f2cce0">More...</a><br/></td></tr> <tr class="separator:ae8bd899daf6b1f890d6cc54f97f2cce0"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Bit map API. </p> <p>The bitmap api is useful for running set operations on objects indexed by unsigned integers. </p> </div><h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="a29975ed2f9842ae16eb2b56d3dde62cb"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned long bitmap_cardinality </td> <td>(</td> <td class="paramtype">const bitmap * </td> <td class="paramname"><em>bm</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Obtain cardinality (max number of elements) of the bitmaptor. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">bm</td><td>The bitmaptor to check </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The cardinality of the bitmaptor </dd></dl> </div> </div> <a class="anchor" id="a621e8f4bbc3401e6f833f5a3df904a66"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void bitmap_clear </td> <td>(</td> <td class="paramtype">bitmap * </td> <td class="paramname"><em>bm</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Unset all bits in a bitmap. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">bm</td><td>The bitmap to clear </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ae8bd899daf6b1f890d6cc54f97f2cce0"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int bitmap_cmp </td> <td>(</td> <td class="paramtype">const bitmap * </td> <td class="paramname"><em>a</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const bitmap * </td> <td class="paramname"><em>b</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Compare two bitmaps for equality. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">a</td><td>The first bitmaptor </td></tr> <tr><td class="paramname">b</td><td>The other bitmaptor </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>Similar to memcmp(), with tiebreaks determined by cardinality </dd></dl> </div> </div> <a class="anchor" id="af5789a6348bf94b3b47d82717dc76cbc"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bitmap* bitmap_copy </td> <td>(</td> <td class="paramtype">const bitmap * </td> <td class="paramname"><em>bm</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Copy a bitmaptor. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">bm</td><td>The bitmaptor to copy </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>Pointer to an identical bitmap on success, NULL on errors </dd></dl> </div> </div> <a class="anchor" id="a36b34f5fe906fb8de09859f10ebbc12e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned long bitmap_count_set_bits </td> <td>(</td> <td class="paramtype">const bitmap * </td> <td class="paramname"><em>bm</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Count set bits in map. </p> <p>Completed in O(n/8) time. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">bm</td><td>The bitmaptor to count bits in </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The number of set bits </dd></dl> </div> </div> <a class="anchor" id="a88fdad890d533243f692584f966ddb71"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned long bitmap_count_unset_bits </td> <td>(</td> <td class="paramtype">const bitmap * </td> <td class="paramname"><em>bm</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Count unset bits in map. </p> <p>Completed in O(n/8) time. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">bm</td><td>The bitmaptor to count bits in </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The number of set bits </dd></dl> </div> </div> <a class="anchor" id="a9001629114e98185f3de713bc128db79"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bitmap* bitmap_create </td> <td>(</td> <td class="paramtype">unsigned long </td> <td class="paramname"><em>size</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Create a bitmaptor of size 'size'. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">size</td><td>Desired storage capacity </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>A bitmap pointer on success, NULL on errors </dd></dl> </div> </div> <a class="anchor" id="a58ee6def2e0c32c5da45523cd446eefe"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void bitmap_destroy </td> <td>(</td> <td class="paramtype">bitmap * </td> <td class="paramname"><em>bm</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Destroy a bitmaptor by freeing all the memory it uses. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">bm</td><td>The bitmaptor to destroy </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a5cc918f8a86d7ed60b99972deed2f9c1"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bitmap* bitmap_diff </td> <td>(</td> <td class="paramtype">const bitmap * </td> <td class="paramname"><em>a</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const bitmap * </td> <td class="paramname"><em>b</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Calculate set difference between two bitmaps The set difference of A / B is defined as all members of A that isn't members of B. </p> <p>Note that parameter ordering matters for this function. This function completes in O(n/sizeof(long)) operations. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">a</td><td>The first bitmaptor (numerator) </td></tr> <tr><td class="paramname">b</td><td>The first bitmaptor (denominator) </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>NULL on errors; A newly created bitmaptor on success. </dd></dl> </div> </div> <a class="anchor" id="a3f3798a3c5b83114a16ad3225e695300"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bitmap* bitmap_intersect </td> <td>(</td> <td class="paramtype">const bitmap * </td> <td class="paramname"><em>a</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const bitmap * </td> <td class="paramname"><em>b</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Calculate intersection of two bitmaps The intersection is defined as all bits that are members of both A and B. </p> <p>It's equivalent to bitwise AND. This function completes in O(n/sizeof(long)) operations. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">a</td><td>The first bitmaptor </td></tr> <tr><td class="paramname">b</td><td>The second bitmaptor </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>NULL on errors; A newly created bitmaptor on success. </dd></dl> </div> </div> <a class="anchor" id="ade96a1d41217133b0a126269a425f43c"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int bitmap_isset </td> <td>(</td> <td class="paramtype">const bitmap * </td> <td class="paramname"><em>bm</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned long </td> <td class="paramname"><em>pos</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Check if a particular bit is set in the map. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">bm</td><td>The bitmaptor to check </td></tr> <tr><td class="paramname">pos</td><td>Position of the bit to check </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>1 if set, otherwise 0 </dd></dl> </div> </div> <a class="anchor" id="a320b74f09439cec263cb75097d404ef6"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int bitmap_resize </td> <td>(</td> <td class="paramtype">bitmap * </td> <td class="paramname"><em>bm</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned long </td> <td class="paramname"><em>size</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Resize a bitmap If the bitmap is made smaller, data will silently be lost. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">bm</td><td>The bitmap to resize </td></tr> <tr><td class="paramname">size</td><td>The new desired size of the bitmap </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on errors. </dd></dl> </div> </div> <a class="anchor" id="a7543817ea7a0f3ab5564470854face7f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int bitmap_set </td> <td>(</td> <td class="paramtype">bitmap * </td> <td class="paramname"><em>bm</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned long </td> <td class="paramname"><em>pos</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Set a bit in the map. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">bm</td><td>The bitmaptor to operate on </td></tr> <tr><td class="paramname">pos</td><td>Position of the bit to set </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on errors </dd></dl> </div> </div> <a class="anchor" id="ab19ee1287ef544fc2720da707d8994af"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bitmap* bitmap_symdiff </td> <td>(</td> <td class="paramtype">const bitmap * </td> <td class="paramname"><em>a</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const bitmap * </td> <td class="paramname"><em>b</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Calculate symmetric difference between two bitmaps The symmetric difference between A and B is the set that contains all elements in either set but not in both. </p> <p>This function completes in O(n/sizeof(long)) operations. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">a</td><td>The first bitmaptor </td></tr> <tr><td class="paramname">b</td><td>The second bitmaptor </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ae7912606995b5bd22452f23b843f0cd3"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bitmap* bitmap_union </td> <td>(</td> <td class="paramtype">const bitmap * </td> <td class="paramname"><em>a</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const bitmap * </td> <td class="paramname"><em>b</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Calculate union of two bitmaps The union is defined as all bits that are members of A or B or both A and B. </p> <p>It's equivalent to bitwise OR. This function completes in O(n/sizeof(long)) operations. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">a</td><td>The first bitmaptor </td></tr> <tr><td class="paramname">b</td><td>The second bitmaptor </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>NULL on errors; A newly created bitmaptor on success. </dd></dl> </div> </div> <a class="anchor" id="a6398726cbb15e5bcc3a1a20c09a1d620"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bitmap* bitmap_unite </td> <td>(</td> <td class="paramtype">bitmap * </td> <td class="paramname"><em>res</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const bitmap * </td> <td class="paramname"><em>addme</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Calculate union of two bitmaps and store result in one of them. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">res</td><td>The first bitmap </td></tr> <tr><td class="paramname">addme</td><td>The bitmap to unite to the first bitmap </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>NULL on errors, res on success </dd></dl> </div> </div> <a class="anchor" id="a7adb33826e021cfda5718653a92585cc"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int bitmap_unset </td> <td>(</td> <td class="paramtype">bitmap * </td> <td class="paramname"><em>bm</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned long </td> <td class="paramname"><em>pos</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Unset a particular bit in the map. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">bm</td><td>The bitmaptor to operate on </td></tr> <tr><td class="paramname">pos</td><td>Position of the bit to unset </td></tr> </table> </dd> </dl> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.5 </small></address> </body> </html>