blob: 34070ff11a033bd6c5865b75de39cda6b72692d6 [file]
<!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.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>iceberg-cpp: iceberg::RoaringPositionBitmap Class 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/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectrow">
<td id="projectalign">
<div id="projectname">iceberg-cpp
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>iceberg</b></li><li class="navelem"><a class="el" href="classiceberg_1_1RoaringPositionBitmap.html">RoaringPositionBitmap</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="classiceberg_1_1RoaringPositionBitmap-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::RoaringPositionBitmap Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A bitmap that supports positive 64-bit positions, optimized for cases where most positions fit in 32 bits.
<a href="classiceberg_1_1RoaringPositionBitmap.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="roaring__position__bitmap_8h_source.html">roaring_position_bitmap.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1RoaringPositionBitmap_1_1Impl.html">Impl</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5416b9dc9d43495aa2310316ba4dfbfe" id="r_a5416b9dc9d43495aa2310316ba4dfbfe"><td class="memItemLeft" align="right" valign="top"><a id="a5416b9dc9d43495aa2310316ba4dfbfe" name="a5416b9dc9d43495aa2310316ba4dfbfe"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>RoaringPositionBitmap</b> (<a class="el" href="classiceberg_1_1RoaringPositionBitmap.html">RoaringPositionBitmap</a> &amp;&amp;other) noexcept</td></tr>
<tr class="separator:a5416b9dc9d43495aa2310316ba4dfbfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a662b2f3ef56952a5e57a4e9c2c3ccff6" id="r_a662b2f3ef56952a5e57a4e9c2c3ccff6"><td class="memItemLeft" align="right" valign="top"><a id="a662b2f3ef56952a5e57a4e9c2c3ccff6" name="a662b2f3ef56952a5e57a4e9c2c3ccff6"></a>
<a class="el" href="classiceberg_1_1RoaringPositionBitmap.html">RoaringPositionBitmap</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classiceberg_1_1RoaringPositionBitmap.html">RoaringPositionBitmap</a> &amp;&amp;other) noexcept</td></tr>
<tr class="separator:a662b2f3ef56952a5e57a4e9c2c3ccff6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5552b6f7ad81aed46bbf6559f67f6df" id="r_aa5552b6f7ad81aed46bbf6559f67f6df"><td class="memItemLeft" align="right" valign="top"><a id="aa5552b6f7ad81aed46bbf6559f67f6df" name="aa5552b6f7ad81aed46bbf6559f67f6df"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>RoaringPositionBitmap</b> (const <a class="el" href="classiceberg_1_1RoaringPositionBitmap.html">RoaringPositionBitmap</a> &amp;other)</td></tr>
<tr class="separator:aa5552b6f7ad81aed46bbf6559f67f6df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a334670484321ea4ede0ea98f8692dd3a" id="r_a334670484321ea4ede0ea98f8692dd3a"><td class="memItemLeft" align="right" valign="top"><a id="a334670484321ea4ede0ea98f8692dd3a" name="a334670484321ea4ede0ea98f8692dd3a"></a>
<a class="el" href="classiceberg_1_1RoaringPositionBitmap.html">RoaringPositionBitmap</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classiceberg_1_1RoaringPositionBitmap.html">RoaringPositionBitmap</a> &amp;other)</td></tr>
<tr class="separator:a334670484321ea4ede0ea98f8692dd3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e70876825b49c748e7398ea67797ad2" id="r_a1e70876825b49c748e7398ea67797ad2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1RoaringPositionBitmap.html#a1e70876825b49c748e7398ea67797ad2">Add</a> (int64_t pos)</td></tr>
<tr class="memdesc:a1e70876825b49c748e7398ea67797ad2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets a position in the bitmap. <br /></td></tr>
<tr class="separator:a1e70876825b49c748e7398ea67797ad2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72c60f02115ce8c0f6b0af77c924c788" id="r_a72c60f02115ce8c0f6b0af77c924c788"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1RoaringPositionBitmap.html#a72c60f02115ce8c0f6b0af77c924c788">AddRange</a> (int64_t pos_start, int64_t pos_end)</td></tr>
<tr class="memdesc:a72c60f02115ce8c0f6b0af77c924c788"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets a range of positions [pos_start, pos_end). <br /></td></tr>
<tr class="separator:a72c60f02115ce8c0f6b0af77c924c788"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a879bd5fa35237a9c7a02ebe6f9894aae" id="r_a879bd5fa35237a9c7a02ebe6f9894aae"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1RoaringPositionBitmap.html#a879bd5fa35237a9c7a02ebe6f9894aae">Contains</a> (int64_t pos) const</td></tr>
<tr class="memdesc:a879bd5fa35237a9c7a02ebe6f9894aae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if a position is set in the bitmap. <br /></td></tr>
<tr class="separator:a879bd5fa35237a9c7a02ebe6f9894aae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2aaa7d0510ee162826bd6098b46d121" id="r_ac2aaa7d0510ee162826bd6098b46d121"><td class="memItemLeft" align="right" valign="top"><a id="ac2aaa7d0510ee162826bd6098b46d121" name="ac2aaa7d0510ee162826bd6098b46d121"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>IsEmpty</b> () const</td></tr>
<tr class="memdesc:ac2aaa7d0510ee162826bd6098b46d121"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the bitmap has no positions set. <br /></td></tr>
<tr class="separator:ac2aaa7d0510ee162826bd6098b46d121"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a603608e39b0124033af3c7a4378a69f4" id="r_a603608e39b0124033af3c7a4378a69f4"><td class="memItemLeft" align="right" valign="top"><a id="a603608e39b0124033af3c7a4378a69f4" name="a603608e39b0124033af3c7a4378a69f4"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>Cardinality</b> () const</td></tr>
<tr class="memdesc:a603608e39b0124033af3c7a4378a69f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of set positions in the bitmap. <br /></td></tr>
<tr class="separator:a603608e39b0124033af3c7a4378a69f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6809de3aa2a29cdaf3101e5f527d0b69" id="r_a6809de3aa2a29cdaf3101e5f527d0b69"><td class="memItemLeft" align="right" valign="top"><a id="a6809de3aa2a29cdaf3101e5f527d0b69" name="a6809de3aa2a29cdaf3101e5f527d0b69"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Or</b> (const <a class="el" href="classiceberg_1_1RoaringPositionBitmap.html">RoaringPositionBitmap</a> &amp;other)</td></tr>
<tr class="memdesc:a6809de3aa2a29cdaf3101e5f527d0b69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Merges all positions from the other bitmap into this one (in-place union). <br /></td></tr>
<tr class="separator:a6809de3aa2a29cdaf3101e5f527d0b69"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1c4887626f845e63b1f7a63abe8a212" id="r_af1c4887626f845e63b1f7a63abe8a212"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1RoaringPositionBitmap.html#af1c4887626f845e63b1f7a63abe8a212">Optimize</a> ()</td></tr>
<tr class="memdesc:af1c4887626f845e63b1f7a63abe8a212"><td class="mdescLeft">&#160;</td><td class="mdescRight">Optimizes the bitmap by applying run-length encoding to containers where it is more space efficient than array or bitset representations. <br /></td></tr>
<tr class="separator:af1c4887626f845e63b1f7a63abe8a212"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18779d584375bed659ba2c38a1ee2bb4" id="r_a18779d584375bed659ba2c38a1ee2bb4"><td class="memItemLeft" align="right" valign="top"><a id="a18779d584375bed659ba2c38a1ee2bb4" name="a18779d584375bed659ba2c38a1ee2bb4"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>ForEach</b> (const std::function&lt; void(int64_t)&gt; &amp;fn) const</td></tr>
<tr class="memdesc:a18779d584375bed659ba2c38a1ee2bb4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Iterates over all set positions in ascending order. <br /></td></tr>
<tr class="separator:a18779d584375bed659ba2c38a1ee2bb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:affcf76ee2ea560cfeb18741c0cadb9d6" id="r_affcf76ee2ea560cfeb18741c0cadb9d6"><td class="memItemLeft" align="right" valign="top"><a id="affcf76ee2ea560cfeb18741c0cadb9d6" name="affcf76ee2ea560cfeb18741c0cadb9d6"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>SerializedSizeInBytes</b> () const</td></tr>
<tr class="memdesc:affcf76ee2ea560cfeb18741c0cadb9d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the serialized size in bytes. <br /></td></tr>
<tr class="separator:affcf76ee2ea560cfeb18741c0cadb9d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5cbc934ea12bb261fbd5a689ed5d4509" id="r_a5cbc934ea12bb261fbd5a689ed5d4509"><td class="memItemLeft" align="right" valign="top"><a id="a5cbc934ea12bb261fbd5a689ed5d4509" name="a5cbc934ea12bb261fbd5a689ed5d4509"></a>
Result&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Serialize</b> () const</td></tr>
<tr class="memdesc:a5cbc934ea12bb261fbd5a689ed5d4509"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes using the portable format (little-endian). <br /></td></tr>
<tr class="separator:a5cbc934ea12bb261fbd5a689ed5d4509"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a37cc9ce0eefa12dbeabb77edc6dd680b" id="r_a37cc9ce0eefa12dbeabb77edc6dd680b"><td class="memItemLeft" align="right" valign="top"><a id="a37cc9ce0eefa12dbeabb77edc6dd680b" name="a37cc9ce0eefa12dbeabb77edc6dd680b"></a>
static Result&lt; <a class="el" href="classiceberg_1_1RoaringPositionBitmap.html">RoaringPositionBitmap</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Deserialize</b> (std::string_view bytes)</td></tr>
<tr class="memdesc:a37cc9ce0eefa12dbeabb77edc6dd680b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deserializes a bitmap from bytes. <br /></td></tr>
<tr class="separator:a37cc9ce0eefa12dbeabb77edc6dd680b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a96daf8d6091c3da17dd542ab0cb50b16" id="r_a96daf8d6091c3da17dd542ab0cb50b16"><td class="memItemLeft" align="right" valign="top"><a id="a96daf8d6091c3da17dd542ab0cb50b16" name="a96daf8d6091c3da17dd542ab0cb50b16"></a>
static constexpr int64_t&#160;</td><td class="memItemRight" valign="bottom"><b>kMaxPosition</b> = 0x7FFFFFFE80000000LL</td></tr>
<tr class="memdesc:a96daf8d6091c3da17dd542ab0cb50b16"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum supported position (aligned with the Java implementation). <br /></td></tr>
<tr class="separator:a96daf8d6091c3da17dd542ab0cb50b16"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A bitmap that supports positive 64-bit positions, optimized for cases where most positions fit in 32 bits. </p>
<p>Incoming 64-bit positions are divided into a 32-bit "key" using the most significant 4 bytes and a 32-bit position using the least significant 4 bytes. For each key, a 32-bit Roaring bitmap is maintained to store positions for that key. </p><dl class="section note"><dt>Note</dt><dd>This class is used to represent deletion vectors. The Puffin puffin reader/write handle adding the additional required framing (length prefix, magic, magic bytes, CRC-32) for <code>deletion-vector-v1</code> persistence. </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a1e70876825b49c748e7398ea67797ad2" name="a1e70876825b49c748e7398ea67797ad2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e70876825b49c748e7398ea67797ad2">&#9670;&#160;</a></span>Add()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void iceberg::RoaringPositionBitmap::Add </td>
<td>(</td>
<td class="paramtype">int64_t&#160;</td>
<td class="paramname"><em>pos</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets a position in the bitmap. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pos</td><td>the position (must be &gt;= 0 and &lt;= kMaxPosition) </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Invalid positions are silently ignored </dd></dl>
</div>
</div>
<a id="a72c60f02115ce8c0f6b0af77c924c788" name="a72c60f02115ce8c0f6b0af77c924c788"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72c60f02115ce8c0f6b0af77c924c788">&#9670;&#160;</a></span>AddRange()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void iceberg::RoaringPositionBitmap::AddRange </td>
<td>(</td>
<td class="paramtype">int64_t&#160;</td>
<td class="paramname"><em>pos_start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int64_t&#160;</td>
<td class="paramname"><em>pos_end</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets a range of positions [pos_start, pos_end). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pos_start</td><td>the start of the range (inclusive), clamped to 0 </td></tr>
<tr><td class="paramname">pos_end</td><td>the end of the range (exclusive), clamped to kMaxPosition + 1 </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>If pos_start &gt; pos_end, the call is silently ignored. If pos_start == pos_end, this method does nothing. Positions outside [0, kMaxPosition] are silently ignored. </dd></dl>
</div>
</div>
<a id="a879bd5fa35237a9c7a02ebe6f9894aae" name="a879bd5fa35237a9c7a02ebe6f9894aae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a879bd5fa35237a9c7a02ebe6f9894aae">&#9670;&#160;</a></span>Contains()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool iceberg::RoaringPositionBitmap::Contains </td>
<td>(</td>
<td class="paramtype">int64_t&#160;</td>
<td class="paramname"><em>pos</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if a position is set in the bitmap. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pos</td><td>the position to check </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the position is set, false otherwise (including invalid positions) </dd></dl>
</div>
</div>
<a id="af1c4887626f845e63b1f7a63abe8a212" name="af1c4887626f845e63b1f7a63abe8a212"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1c4887626f845e63b1f7a63abe8a212">&#9670;&#160;</a></span>Optimize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool iceberg::RoaringPositionBitmap::Optimize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Optimizes the bitmap by applying run-length encoding to containers where it is more space efficient than array or bitset representations. </p>
<dl class="section return"><dt>Returns</dt><dd>true if any container was changed </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>iceberg/deletes/<a class="el" href="roaring__position__bitmap_8h_source.html">roaring_position_bitmap.h</a></li>
<li>iceberg/deletes/<b>roaring_position_bitmap.cc</b></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>