Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./mkdocs/docs/api/classiceberg_1_1PartitionSet.html
blob: deed942c68e5c5f08eab71e01f9a3718e4fe47bf [file] [log] [blame]
<!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::PartitionSet 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_1PartitionSet.html">PartitionSet</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classiceberg_1_1PartitionSet-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::PartitionSet Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A set that uses a pair of spec ID and partition tuple as elements.
<a href="classiceberg_1_1PartitionSet.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="partition__value__util_8h_source.html">partition_value_util.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a0d0480d37a279532fe5b40e6dbe2c52c" id="r_a0d0480d37a279532fe5b40e6dbe2c52c"><td class="memItemLeft" align="right" valign="top"><a id="a0d0480d37a279532fe5b40e6dbe2c52c" name="a0d0480d37a279532fe5b40e6dbe2c52c"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>set_type</b> = std::unordered_set&lt; PartitionKey, <a class="el" href="structiceberg_1_1PartitionKeyHash.html">PartitionKeyHash</a>, <a class="el" href="structiceberg_1_1PartitionKeyEqual.html">PartitionKeyEqual</a> &gt;</td></tr>
<tr class="separator:a0d0480d37a279532fe5b40e6dbe2c52c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a724e452bd78a36a747cacc5c216d8a55" id="r_a724e452bd78a36a747cacc5c216d8a55"><td class="memItemLeft" align="right" valign="top"><a id="a724e452bd78a36a747cacc5c216d8a55" name="a724e452bd78a36a747cacc5c216d8a55"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>iterator</b> = typename set_type::iterator</td></tr>
<tr class="separator:a724e452bd78a36a747cacc5c216d8a55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a475b10815ab22f062fef0ce7d996d3b2" id="r_a475b10815ab22f062fef0ce7d996d3b2"><td class="memItemLeft" align="right" valign="top"><a id="a475b10815ab22f062fef0ce7d996d3b2" name="a475b10815ab22f062fef0ce7d996d3b2"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>const_iterator</b> = typename set_type::const_iterator</td></tr>
<tr class="separator:a475b10815ab22f062fef0ce7d996d3b2"><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:a684a0ae11210a1020acf0021d6cc1391" id="r_a684a0ae11210a1020acf0021d6cc1391"><td class="memItemLeft" align="right" valign="top"><a id="a684a0ae11210a1020acf0021d6cc1391" name="a684a0ae11210a1020acf0021d6cc1391"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>size</b> () const</td></tr>
<tr class="memdesc:a684a0ae11210a1020acf0021d6cc1391"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number of elements in the set. <br /></td></tr>
<tr class="separator:a684a0ae11210a1020acf0021d6cc1391"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5fd71adff5f78784d31e958a5a61756" id="r_ae5fd71adff5f78784d31e958a5a61756"><td class="memItemLeft" align="right" valign="top"><a id="ae5fd71adff5f78784d31e958a5a61756" name="ae5fd71adff5f78784d31e958a5a61756"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>empty</b> () const</td></tr>
<tr class="memdesc:ae5fd71adff5f78784d31e958a5a61756"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the set is empty. <br /></td></tr>
<tr class="separator:ae5fd71adff5f78784d31e958a5a61756"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa62a783fd9c1bd65c288712c9357452f" id="r_aa62a783fd9c1bd65c288712c9357452f"><td class="memItemLeft" align="right" valign="top"><a id="aa62a783fd9c1bd65c288712c9357452f" name="aa62a783fd9c1bd65c288712c9357452f"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>clear</b> ()</td></tr>
<tr class="memdesc:aa62a783fd9c1bd65c288712c9357452f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear all elements from the set. <br /></td></tr>
<tr class="separator:aa62a783fd9c1bd65c288712c9357452f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca01f4e8721f51250d3da320425db652" id="r_aca01f4e8721f51250d3da320425db652"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1PartitionSet.html#aca01f4e8721f51250d3da320425db652">contains</a> (int32_t spec_id, const <a class="el" href="classiceberg_1_1PartitionValues.html">PartitionValues</a> &amp;values) const</td></tr>
<tr class="memdesc:aca01f4e8721f51250d3da320425db652"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the set contains an element. <br /></td></tr>
<tr class="separator:aca01f4e8721f51250d3da320425db652"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c4223067249ddd6253798d4d509eb3a" id="r_a2c4223067249ddd6253798d4d509eb3a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1PartitionSet.html#a2c4223067249ddd6253798d4d509eb3a">add</a> (int32_t spec_id, <a class="el" href="classiceberg_1_1PartitionValues.html">PartitionValues</a> values)</td></tr>
<tr class="memdesc:a2c4223067249ddd6253798d4d509eb3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add an element to the set. <br /></td></tr>
<tr class="separator:a2c4223067249ddd6253798d4d509eb3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0cd35b23f1b23a4eeb6f1ab0c435baa" id="r_ae0cd35b23f1b23a4eeb6f1ab0c435baa"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1PartitionSet.html#ae0cd35b23f1b23a4eeb6f1ab0c435baa">remove</a> (int32_t spec_id, const <a class="el" href="classiceberg_1_1PartitionValues.html">PartitionValues</a> &amp;values)</td></tr>
<tr class="memdesc:ae0cd35b23f1b23a4eeb6f1ab0c435baa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove an element from the set. <br /></td></tr>
<tr class="separator:ae0cd35b23f1b23a4eeb6f1ab0c435baa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4296024c9e53850144848055a6c01125" id="r_a4296024c9e53850144848055a6c01125"><td class="memItemLeft" align="right" valign="top"><a id="a4296024c9e53850144848055a6c01125" name="a4296024c9e53850144848055a6c01125"></a>
iterator&#160;</td><td class="memItemRight" valign="bottom"><b>begin</b> ()</td></tr>
<tr class="memdesc:a4296024c9e53850144848055a6c01125"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get iterator to the beginning. <br /></td></tr>
<tr class="separator:a4296024c9e53850144848055a6c01125"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0a6ae4bce87545e026bee6e9dd039d1" id="r_ae0a6ae4bce87545e026bee6e9dd039d1"><td class="memItemLeft" align="right" valign="top"><a id="ae0a6ae4bce87545e026bee6e9dd039d1" name="ae0a6ae4bce87545e026bee6e9dd039d1"></a>
const_iterator&#160;</td><td class="memItemRight" valign="bottom"><b>begin</b> () const</td></tr>
<tr class="separator:ae0a6ae4bce87545e026bee6e9dd039d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac29d26e718cffc14372e29cb6cf8cba7" id="r_ac29d26e718cffc14372e29cb6cf8cba7"><td class="memItemLeft" align="right" valign="top"><a id="ac29d26e718cffc14372e29cb6cf8cba7" name="ac29d26e718cffc14372e29cb6cf8cba7"></a>
const_iterator&#160;</td><td class="memItemRight" valign="bottom"><b>cbegin</b> () const</td></tr>
<tr class="separator:ac29d26e718cffc14372e29cb6cf8cba7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a984b44a4f4165b083f969795abf1427a" id="r_a984b44a4f4165b083f969795abf1427a"><td class="memItemLeft" align="right" valign="top"><a id="a984b44a4f4165b083f969795abf1427a" name="a984b44a4f4165b083f969795abf1427a"></a>
iterator&#160;</td><td class="memItemRight" valign="bottom"><b>end</b> ()</td></tr>
<tr class="memdesc:a984b44a4f4165b083f969795abf1427a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get iterator to the end. <br /></td></tr>
<tr class="separator:a984b44a4f4165b083f969795abf1427a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a968a51e5d2a165cddc012aed9c76c0eb" id="r_a968a51e5d2a165cddc012aed9c76c0eb"><td class="memItemLeft" align="right" valign="top"><a id="a968a51e5d2a165cddc012aed9c76c0eb" name="a968a51e5d2a165cddc012aed9c76c0eb"></a>
const_iterator&#160;</td><td class="memItemRight" valign="bottom"><b>end</b> () const</td></tr>
<tr class="separator:a968a51e5d2a165cddc012aed9c76c0eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2075efef9f4cf3b6d71d3c09d99c1ee4" id="r_a2075efef9f4cf3b6d71d3c09d99c1ee4"><td class="memItemLeft" align="right" valign="top"><a id="a2075efef9f4cf3b6d71d3c09d99c1ee4" name="a2075efef9f4cf3b6d71d3c09d99c1ee4"></a>
const_iterator&#160;</td><td class="memItemRight" valign="bottom"><b>cend</b> () const</td></tr>
<tr class="separator:a2075efef9f4cf3b6d71d3c09d99c1ee4"><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 set that uses a pair of spec ID and partition tuple as elements. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a2c4223067249ddd6253798d4d509eb3a" name="a2c4223067249ddd6253798d4d509eb3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c4223067249ddd6253798d4d509eb3a">&#9670;&#160;</a></span>add()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool iceberg::PartitionSet::add </td>
<td>(</td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>spec_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classiceberg_1_1PartitionValues.html">PartitionValues</a>&#160;</td>
<td class="paramname"><em>values</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Add an element to the set. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">spec_id</td><td>The partition spec ID. </td></tr>
<tr><td class="paramname">values</td><td>The partition values. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the element was added, false if it already existed. </dd></dl>
</div>
</div>
<a id="aca01f4e8721f51250d3da320425db652" name="aca01f4e8721f51250d3da320425db652"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca01f4e8721f51250d3da320425db652">&#9670;&#160;</a></span>contains()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool iceberg::PartitionSet::contains </td>
<td>(</td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>spec_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classiceberg_1_1PartitionValues.html">PartitionValues</a> &amp;&#160;</td>
<td class="paramname"><em>values</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the set contains an element. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">spec_id</td><td>The partition spec ID. </td></tr>
<tr><td class="paramname">values</td><td>The partition values. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the element exists, false otherwise. </dd></dl>
</div>
</div>
<a id="ae0cd35b23f1b23a4eeb6f1ab0c435baa" name="ae0cd35b23f1b23a4eeb6f1ab0c435baa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0cd35b23f1b23a4eeb6f1ab0c435baa">&#9670;&#160;</a></span>remove()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool iceberg::PartitionSet::remove </td>
<td>(</td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>spec_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classiceberg_1_1PartitionValues.html">PartitionValues</a> &amp;&#160;</td>
<td class="paramname"><em>values</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove an element from the set. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">spec_id</td><td>The partition spec ID. </td></tr>
<tr><td class="paramname">values</td><td>The partition values. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the element was removed, false if it didn't exist. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>iceberg/util/<a class="el" href="partition__value__util_8h_source.html">partition_value_util.h</a></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>