Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./api/classiceberg_1_1DataFileSet.html
blob: d97d612a7876d609e7190c7376834eebf1b8a3be [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::DataFileSet 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_1DataFileSet.html">DataFileSet</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_1DataFileSet-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::DataFileSet Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A set of <a class="el" href="structiceberg_1_1DataFile.html" title="DataFile carries data file path, partition tuple, metrics, ...">DataFile</a> pointers with insertion order preserved and deduplicated by file path.
<a href="classiceberg_1_1DataFileSet.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="data__file__set_8h_source.html">data_file_set.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:abae3888e612ba9a78f1d57135361b7ee" id="r_abae3888e612ba9a78f1d57135361b7ee"><td class="memItemLeft" align="right" valign="top"><a id="abae3888e612ba9a78f1d57135361b7ee" name="abae3888e612ba9a78f1d57135361b7ee"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>value_type</b> = std::shared_ptr&lt; <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &gt;</td></tr>
<tr class="separator:abae3888e612ba9a78f1d57135361b7ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af782885a799c24a67409d3d11a545946" id="r_af782885a799c24a67409d3d11a545946"><td class="memItemLeft" align="right" valign="top"><a id="af782885a799c24a67409d3d11a545946" name="af782885a799c24a67409d3d11a545946"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>iterator</b> = typename std::vector&lt; value_type &gt;::iterator</td></tr>
<tr class="separator:af782885a799c24a67409d3d11a545946"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe2c8628e985bbb74c059f33010a0de5" id="r_abe2c8628e985bbb74c059f33010a0de5"><td class="memItemLeft" align="right" valign="top"><a id="abe2c8628e985bbb74c059f33010a0de5" name="abe2c8628e985bbb74c059f33010a0de5"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>const_iterator</b> = typename std::vector&lt; value_type &gt;::const_iterator</td></tr>
<tr class="separator:abe2c8628e985bbb74c059f33010a0de5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a54d17a1c55aa7ba88e019ff747ba35" id="r_a8a54d17a1c55aa7ba88e019ff747ba35"><td class="memItemLeft" align="right" valign="top"><a id="a8a54d17a1c55aa7ba88e019ff747ba35" name="a8a54d17a1c55aa7ba88e019ff747ba35"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>difference_type</b> = typename std::vector&lt; value_type &gt;::difference_type</td></tr>
<tr class="separator:a8a54d17a1c55aa7ba88e019ff747ba35"><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:ad8a1b43807bbc7496a21575abb71b431" id="r_ad8a1b43807bbc7496a21575abb71b431"><td class="memItemLeft" align="right" valign="top">std::pair&lt; iterator, bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1DataFileSet.html#ad8a1b43807bbc7496a21575abb71b431">insert</a> (const value_type &amp;file)</td></tr>
<tr class="memdesc:ad8a1b43807bbc7496a21575abb71b431"><td class="mdescLeft">&#160;</td><td class="mdescRight">Insert a data file into the set. <br /></td></tr>
<tr class="separator:ad8a1b43807bbc7496a21575abb71b431"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afda7eaffede5ab7d274fd2e505775bfe" id="r_afda7eaffede5ab7d274fd2e505775bfe"><td class="memItemLeft" align="right" valign="top"><a id="afda7eaffede5ab7d274fd2e505775bfe" name="afda7eaffede5ab7d274fd2e505775bfe"></a>
std::pair&lt; iterator, bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>insert</b> (value_type &amp;&amp;file)</td></tr>
<tr class="memdesc:afda7eaffede5ab7d274fd2e505775bfe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Insert a data file into the set (move version). <br /></td></tr>
<tr class="separator:afda7eaffede5ab7d274fd2e505775bfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad05372f48830697956a2002f9272cf65" id="r_ad05372f48830697956a2002f9272cf65"><td class="memItemLeft" align="right" valign="top"><a id="ad05372f48830697956a2002f9272cf65" name="ad05372f48830697956a2002f9272cf65"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>size</b> () const</td></tr>
<tr class="memdesc:ad05372f48830697956a2002f9272cf65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number of elements in the set. <br /></td></tr>
<tr class="separator:ad05372f48830697956a2002f9272cf65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa1c160bbab9d68e42883283edae4942" id="r_afa1c160bbab9d68e42883283edae4942"><td class="memItemLeft" align="right" valign="top"><a id="afa1c160bbab9d68e42883283edae4942" name="afa1c160bbab9d68e42883283edae4942"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>empty</b> () const</td></tr>
<tr class="memdesc:afa1c160bbab9d68e42883283edae4942"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the set is empty. <br /></td></tr>
<tr class="separator:afa1c160bbab9d68e42883283edae4942"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a676adcaae68f2c53dae70a682534d069" id="r_a676adcaae68f2c53dae70a682534d069"><td class="memItemLeft" align="right" valign="top"><a id="a676adcaae68f2c53dae70a682534d069" name="a676adcaae68f2c53dae70a682534d069"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>clear</b> ()</td></tr>
<tr class="memdesc:a676adcaae68f2c53dae70a682534d069"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear all elements from the set. <br /></td></tr>
<tr class="separator:a676adcaae68f2c53dae70a682534d069"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7aa475024e7475b13fee5b147ad089d" id="r_ae7aa475024e7475b13fee5b147ad089d"><td class="memItemLeft" align="right" valign="top"><a id="ae7aa475024e7475b13fee5b147ad089d" name="ae7aa475024e7475b13fee5b147ad089d"></a>
iterator&#160;</td><td class="memItemRight" valign="bottom"><b>begin</b> ()</td></tr>
<tr class="memdesc:ae7aa475024e7475b13fee5b147ad089d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get iterator to the beginning. <br /></td></tr>
<tr class="separator:ae7aa475024e7475b13fee5b147ad089d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add3c21d4425d34644c7ced0ab0b714a2" id="r_add3c21d4425d34644c7ced0ab0b714a2"><td class="memItemLeft" align="right" valign="top"><a id="add3c21d4425d34644c7ced0ab0b714a2" name="add3c21d4425d34644c7ced0ab0b714a2"></a>
const_iterator&#160;</td><td class="memItemRight" valign="bottom"><b>begin</b> () const</td></tr>
<tr class="separator:add3c21d4425d34644c7ced0ab0b714a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90c5ab8c1c32fad65113ece85ca6ae6c" id="r_a90c5ab8c1c32fad65113ece85ca6ae6c"><td class="memItemLeft" align="right" valign="top"><a id="a90c5ab8c1c32fad65113ece85ca6ae6c" name="a90c5ab8c1c32fad65113ece85ca6ae6c"></a>
const_iterator&#160;</td><td class="memItemRight" valign="bottom"><b>cbegin</b> () const</td></tr>
<tr class="separator:a90c5ab8c1c32fad65113ece85ca6ae6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52f39f16b394f713b5e6940a53a7faec" id="r_a52f39f16b394f713b5e6940a53a7faec"><td class="memItemLeft" align="right" valign="top"><a id="a52f39f16b394f713b5e6940a53a7faec" name="a52f39f16b394f713b5e6940a53a7faec"></a>
iterator&#160;</td><td class="memItemRight" valign="bottom"><b>end</b> ()</td></tr>
<tr class="memdesc:a52f39f16b394f713b5e6940a53a7faec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get iterator to the end. <br /></td></tr>
<tr class="separator:a52f39f16b394f713b5e6940a53a7faec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7df7684042ad76d68e184897433380f8" id="r_a7df7684042ad76d68e184897433380f8"><td class="memItemLeft" align="right" valign="top"><a id="a7df7684042ad76d68e184897433380f8" name="a7df7684042ad76d68e184897433380f8"></a>
const_iterator&#160;</td><td class="memItemRight" valign="bottom"><b>end</b> () const</td></tr>
<tr class="separator:a7df7684042ad76d68e184897433380f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d9bec9ee0e5b116be3a9142318a3d83" id="r_a4d9bec9ee0e5b116be3a9142318a3d83"><td class="memItemLeft" align="right" valign="top"><a id="a4d9bec9ee0e5b116be3a9142318a3d83" name="a4d9bec9ee0e5b116be3a9142318a3d83"></a>
const_iterator&#160;</td><td class="memItemRight" valign="bottom"><b>cend</b> () const</td></tr>
<tr class="separator:a4d9bec9ee0e5b116be3a9142318a3d83"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ab8d749595050f90704212b4afc3a97" id="r_a7ab8d749595050f90704212b4afc3a97"><td class="memItemLeft" align="right" valign="top"><a id="a7ab8d749595050f90704212b4afc3a97" name="a7ab8d749595050f90704212b4afc3a97"></a>
std::span&lt; const value_type &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>as_span</b> () const</td></tr>
<tr class="memdesc:a7ab8d749595050f90704212b4afc3a97"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a non-owning view of the data files in insertion order. <br /></td></tr>
<tr class="separator:a7ab8d749595050f90704212b4afc3a97"><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 of <a class="el" href="structiceberg_1_1DataFile.html" title="DataFile carries data file path, partition tuple, metrics, ...">DataFile</a> pointers with insertion order preserved and deduplicated by file path. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ad8a1b43807bbc7496a21575abb71b431" name="ad8a1b43807bbc7496a21575abb71b431"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8a1b43807bbc7496a21575abb71b431">&#9670;&#160;</a></span>insert()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::pair&lt; iterator, bool &gt; iceberg::DataFileSet::insert </td>
<td>(</td>
<td class="paramtype">const value_type &amp;&#160;</td>
<td class="paramname"><em>file</em></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>Insert a data file into the set. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file</td><td>The data file to insert </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pair with an iterator to the inserted element (or the existing one) and a bool indicating whether insertion took place </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>iceberg/util/<a class="el" href="data__file__set_8h_source.html">data_file_set.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>