backup/C-Plus-Plus
1
0
Fork 0
mirror of https://github.com/TheAlgorithms/C-Plus-Plus.git synced 2026-03-21 04:18:34 +08:00
Code Issues Projects Releases Wiki Activity
Files
gh-pages
C-Plus-Plus/d9/dae/classdata__structures_1_1_bitset.html
realstealthninja b41207008f Documentation for f1eddf4d65
2025-07-09 10:53:16 +00:00

363 lines
20 KiB
HTML
Raw Permalink Blame History

<!-- HTML header for doxygen 1.12.0-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.14.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>TheAlgorithms/C++: data_structures::Bitset Class Reference</title>
<link rel="icon" href="../../favicon.svg" type="image/x-icon" />
<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>
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/@xpack-3rd-party/doxygen-awesome-css@2.2.0-1/doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.init()
</script>
<script type="text/javascript" src="../../clipboard.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript" src="../../cookie.js"></script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<script type="text/javascript">
window.MathJax = {
options: {
ignoreHtmlClass: 'tex2jax_ignore',
processHtmlClass: 'tex2jax_process'
},
loader: {
load: ['[tex]/ams']
},
tex: {
macros: {},
packages: ['base','configmacros','ams']
}
};
</script>
<script type="text/javascript" id="MathJax-script" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
<link href="../../doxygen-awesome.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 id="projectrow">
<td id="projectlogo"><img alt="Logo" src="../../project_logo.png"/></td>
<td id="projectalign">
<div id="projectname">TheAlgorithms/C++<span id="projectnumber">&#160;1.0.0</span>
</div>
<div id="projectbrief">All the algorithms implemented in C++</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.14.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('../../',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
</script>
<div id="main-nav"></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">
$(function(){initNavTree('d9/dae/classdata__structures_1_1_bitset.html','../../','d6/df8/classdata__structures_1_1_bitset-members'); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">data_structures::Bitset Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Simple bitset implementation for bloom filter.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for data_structures::Bitset:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="../../d4/d9a/classdata__structures_1_1_bitset__coll__graph.svg" width="179" height="134"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<center><span class="legend">[<a target="top" href="../../graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a15b05aabb28f9b1896b0a61e8ef60130" id="r_a15b05aabb28f9b1896b0a61e8ef60130"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a15b05aabb28f9b1896b0a61e8ef60130">Bitset</a> (std::size_t)</td></tr>
<tr class="memdesc:a15b05aabb28f9b1896b0a61e8ef60130"><td class="mdescLeft">&#160;</td><td class="mdescRight">BitSet class constructor. <br /></td></tr>
<tr class="memitem:a2f1f44d6a12b0de4aaf242872b1c7b54" id="r_a2f1f44d6a12b0de4aaf242872b1c7b54"><td class="memItemLeft" align="right" valign="top">std::size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2f1f44d6a12b0de4aaf242872b1c7b54">size</a> ()</td></tr>
<tr class="memdesc:a2f1f44d6a12b0de4aaf242872b1c7b54"><td class="mdescLeft">&#160;</td><td class="mdescRight">Utility function to return the size of the inner array. <br /></td></tr>
<tr class="memitem:a17dbe1b1d559302312e8091f82f7499c" id="r_a17dbe1b1d559302312e8091f82f7499c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a17dbe1b1d559302312e8091f82f7499c">add</a> (std::size_t)</td></tr>
<tr class="memdesc:a17dbe1b1d559302312e8091f82f7499c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Turn bit on position x to 1s. <br /></td></tr>
<tr class="memitem:a9ef54c7c3f6494b36ead3ae2e5cf43ac" id="r_a9ef54c7c3f6494b36ead3ae2e5cf43ac"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9ef54c7c3f6494b36ead3ae2e5cf43ac">contains</a> (std::size_t)</td></tr>
<tr class="memdesc:a9ef54c7c3f6494b36ead3ae2e5cf43ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Doest bitset contains element x. <br /></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pri-attribs" class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:ae86688cf99b77342deedb75149573e73" id="r_ae86688cf99b77342deedb75149573e73"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::size_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae86688cf99b77342deedb75149573e73">data</a></td></tr>
<tr class="memdesc:ae86688cf99b77342deedb75149573e73"><td class="mdescLeft">&#160;</td><td class="mdescRight">short info of this variable <br /></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pri-static-attribs" class="groupheader"><a id="pri-static-attribs" name="pri-static-attribs"></a>
Static Private Attributes</h2></td></tr>
<tr class="memitem:ad7f7d479079a95bcc9175465395fa23f" id="r_ad7f7d479079a95bcc9175465395fa23f"><td class="memItemLeft" align="right" valign="top">static const std::size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad7f7d479079a95bcc9175465395fa23f">blockSize</a></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Simple bitset implementation for bloom filter. </p>
<p class="definition">Definition at line <a class="el" href="../../d9/dab/bloom__filter_8cpp_source.html#l00040">40</a> of file <a class="el" href="../../d9/dab/bloom__filter_8cpp_source.html">bloom_filter.cpp</a>.</p>
</div><a name="doc-constructors" id="doc-constructors"></a><h2 id="header-doc-constructors" class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a15b05aabb28f9b1896b0a61e8ef60130" name="a15b05aabb28f9b1896b0a61e8ef60130"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15b05aabb28f9b1896b0a61e8ef60130">&#9670;&#160;</a></span>Bitset()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">data_structures::Bitset::Bitset </td>
<td>(</td>
<td class="paramtype">std::size_t</td> <td class="paramname"><span class="paramname"><em>initSize</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel explicit">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>BitSet class constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">initSize</td><td>amount of blocks, each contain sizeof(std::size_t) bits </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../d9/dab/bloom__filter_8cpp_source.html#l00063">63</a> of file <a class="el" href="../../d9/dab/bloom__filter_8cpp_source.html">bloom_filter.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 63</span>: <a class="code hl_variable" href="#ae86688cf99b77342deedb75149573e73">data</a>(initSize) {}</div>
<div class="ttc" id="aclassdata__structures_1_1_bitset_html_ae86688cf99b77342deedb75149573e73"><div class="ttname"><a href="#ae86688cf99b77342deedb75149573e73">data_structures::Bitset::data</a></div><div class="ttdeci">std::vector&lt; std::size_t &gt; data</div><div class="ttdoc">short info of this variable</div><div class="ttdef"><b>Definition</b> <a href="../../d9/dab/bloom__filter_8cpp_source.html#l00042">bloom_filter.cpp:42</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
<a id="a17dbe1b1d559302312e8091f82f7499c" name="a17dbe1b1d559302312e8091f82f7499c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17dbe1b1d559302312e8091f82f7499c">&#9670;&#160;</a></span>add()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void data_structures::Bitset::add </td>
<td>(</td>
<td class="paramtype">std::size_t</td> <td class="paramname"><span class="paramname"><em>x</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Turn bit on position x to 1s. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>position to turn bit on </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d9/dab/bloom__filter_8cpp_source.html#l00071">71</a> of file <a class="el" href="../../d9/dab/bloom__filter_8cpp_source.html">bloom_filter.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 71</span> {</div>
<div class="line"><span class="lineno"> 72</span> std::size_t blockIndex = x / <a class="code hl_variable" href="#ad7f7d479079a95bcc9175465395fa23f">blockSize</a>;</div>
<div class="line"><span class="lineno"> 73</span> <span class="keywordflow">if</span> (blockIndex &gt;= <a class="code hl_variable" href="#ae86688cf99b77342deedb75149573e73">data</a>.size()) {</div>
<div class="line"><span class="lineno"> 74</span> <a class="code hl_variable" href="#ae86688cf99b77342deedb75149573e73">data</a>.resize(blockIndex + 1);</div>
<div class="line"><span class="lineno"> 75</span> }</div>
<div class="line"><span class="lineno"> 76</span> <a class="code hl_variable" href="#ae86688cf99b77342deedb75149573e73">data</a>[blockIndex] |= 1 &lt;&lt; (x % <a class="code hl_variable" href="#ad7f7d479079a95bcc9175465395fa23f">blockSize</a>);</div>
<div class="line"><span class="lineno"> 77</span>}</div>
<div class="ttc" id="aclassdata__structures_1_1_bitset_html_ad7f7d479079a95bcc9175465395fa23f"><div class="ttname"><a href="#ad7f7d479079a95bcc9175465395fa23f">data_structures::Bitset::blockSize</a></div><div class="ttdeci">static const std::size_t blockSize</div><div class="ttdef"><b>Definition</b> <a href="../../d9/dab/bloom__filter_8cpp_source.html#l00043">bloom_filter.cpp:43</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a id="a9ef54c7c3f6494b36ead3ae2e5cf43ac" name="a9ef54c7c3f6494b36ead3ae2e5cf43ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ef54c7c3f6494b36ead3ae2e5cf43ac">&#9670;&#160;</a></span>contains()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool data_structures::Bitset::contains </td>
<td>(</td>
<td class="paramtype">std::size_t</td> <td class="paramname"><span class="paramname"><em>x</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Doest bitset contains element x. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>position in bitset to check </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if bit position x is 1 </dd>
<dd>
false if bit position x is 0 </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d9/dab/bloom__filter_8cpp_source.html#l00086">86</a> of file <a class="el" href="../../d9/dab/bloom__filter_8cpp_source.html">bloom_filter.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 86</span> {</div>
<div class="line"><span class="lineno"> 87</span> std::size_t blockIndex = x / <a class="code hl_variable" href="#ad7f7d479079a95bcc9175465395fa23f">blockSize</a>;</div>
<div class="line"><span class="lineno"> 88</span> <span class="keywordflow">if</span> (blockIndex &gt;= <a class="code hl_variable" href="#ae86688cf99b77342deedb75149573e73">data</a>.size()) {</div>
<div class="line"><span class="lineno"> 89</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><span class="lineno"> 90</span> }</div>
<div class="line"><span class="lineno"> 91</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="#ae86688cf99b77342deedb75149573e73">data</a>[blockIndex] &amp; (1 &lt;&lt; (x % <a class="code hl_variable" href="#ad7f7d479079a95bcc9175465395fa23f">blockSize</a>));</div>
<div class="line"><span class="lineno"> 92</span>}</div>
</div><!-- fragment -->
</div>
</div>
<a id="a2f1f44d6a12b0de4aaf242872b1c7b54" name="a2f1f44d6a12b0de4aaf242872b1c7b54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f1f44d6a12b0de4aaf242872b1c7b54">&#9670;&#160;</a></span>size()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::size_t data_structures::Bitset::size </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Utility function to return the size of the inner array. </p>
<dl class="section return"><dt>Returns</dt><dd>the size of inner array </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d9/dab/bloom__filter_8cpp_source.html#l00057">57</a> of file <a class="el" href="../../d9/dab/bloom__filter_8cpp_source.html">bloom_filter.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 57</span>{ <span class="keywordflow">return</span> <a class="code hl_variable" href="#ae86688cf99b77342deedb75149573e73">data</a>.size(); }</div>
</div><!-- fragment -->
</div>
</div>
<a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Member Data Documentation</h2>
<a id="ad7f7d479079a95bcc9175465395fa23f" name="ad7f7d479079a95bcc9175465395fa23f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7f7d479079a95bcc9175465395fa23f">&#9670;&#160;</a></span>blockSize</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::size_t data_structures::Bitset::blockSize</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel static">static</span><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">=</div>
<div class="line"> <span class="keyword">sizeof</span>(std::size_t)</div>
</div><!-- fragment --><p>size of integer type, that we are using in our bitset </p>
<p class="definition">Definition at line <a class="el" href="../../d9/dab/bloom__filter_8cpp_source.html#l00043">43</a> of file <a class="el" href="../../d9/dab/bloom__filter_8cpp_source.html">bloom_filter.cpp</a>.</p>
</div>
</div>
<a id="ae86688cf99b77342deedb75149573e73" name="ae86688cf99b77342deedb75149573e73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae86688cf99b77342deedb75149573e73">&#9670;&#160;</a></span>data</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;std::size_t&gt; data_structures::Bitset::data</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>short info of this variable </p>
<p class="definition">Definition at line <a class="el" href="../../d9/dab/bloom__filter_8cpp_source.html#l00042">42</a> of file <a class="el" href="../../d9/dab/bloom__filter_8cpp_source.html">bloom_filter.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>data_structures/<a class="el" href="../../d9/dab/bloom__filter_8cpp_source.html">bloom_filter.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="../../d5/d3c/namespacedata__structures.html">data_structures</a></li><li class="navelem"><a href="../../d9/dae/classdata__structures_1_1_bitset.html">Bitset</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink