Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./api/classiceberg_1_1PartitionValues.html
blob: d06517a8c614112d2152030ec6d987caedce3b4f [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::PartitionValues 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_1PartitionValues.html">PartitionValues</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classiceberg_1_1PartitionValues-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::PartitionValues Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classiceberg_1_1StructLike.html" title="An immutable struct-like wrapper.">StructLike</a> wrapper for a vector of literals that represent partition values.
<a href="classiceberg_1_1PartitionValues.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="partition__values_8h_source.html">partition_values.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for iceberg::PartitionValues:</div>
<div class="dyncontent">
<div class="center">
<img src="classiceberg_1_1PartitionValues.png" usemap="#iceberg::PartitionValues_map" alt=""/>
<map id="iceberg::PartitionValues_map" name="iceberg::PartitionValues_map">
<area href="classiceberg_1_1StructLike.html" title="An immutable struct-like wrapper." alt="iceberg::StructLike" shape="rect" coords="0,0,146,24"/>
</map>
</div></div>
<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:a75a1bd710a63862447e8407edb316b08" id="r_a75a1bd710a63862447e8407edb316b08"><td class="memItemLeft" align="right" valign="top"><a id="a75a1bd710a63862447e8407edb316b08" name="a75a1bd710a63862447e8407edb316b08"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>PartitionValues</b> (std::vector&lt; <a class="el" href="classiceberg_1_1Literal.html">Literal</a> &gt; values)</td></tr>
<tr class="separator:a75a1bd710a63862447e8407edb316b08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72061bfcc9b2913407835fc5f3a8bc17" id="r_a72061bfcc9b2913407835fc5f3a8bc17"><td class="memItemLeft" align="right" valign="top"><a id="a72061bfcc9b2913407835fc5f3a8bc17" name="a72061bfcc9b2913407835fc5f3a8bc17"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>PartitionValues</b> (<a class="el" href="classiceberg_1_1Literal.html">Literal</a> value)</td></tr>
<tr class="separator:a72061bfcc9b2913407835fc5f3a8bc17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a102b23262c8abca309e4f82dbaa256f7" id="r_a102b23262c8abca309e4f82dbaa256f7"><td class="memItemLeft" align="right" valign="top"><a id="a102b23262c8abca309e4f82dbaa256f7" name="a102b23262c8abca309e4f82dbaa256f7"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>PartitionValues</b> (const <a class="el" href="classiceberg_1_1PartitionValues.html">PartitionValues</a> &amp;other)</td></tr>
<tr class="separator:a102b23262c8abca309e4f82dbaa256f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a962c3c649860fc6bbbe0722b4f7bfe" id="r_a2a962c3c649860fc6bbbe0722b4f7bfe"><td class="memItemLeft" align="right" valign="top"><a id="a2a962c3c649860fc6bbbe0722b4f7bfe" name="a2a962c3c649860fc6bbbe0722b4f7bfe"></a>
<a class="el" href="classiceberg_1_1PartitionValues.html">PartitionValues</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classiceberg_1_1PartitionValues.html">PartitionValues</a> &amp;other)</td></tr>
<tr class="separator:a2a962c3c649860fc6bbbe0722b4f7bfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a67802745bb2255cee1d4c22d718fa168" id="r_a67802745bb2255cee1d4c22d718fa168"><td class="memItemLeft" align="right" valign="top"><a id="a67802745bb2255cee1d4c22d718fa168" name="a67802745bb2255cee1d4c22d718fa168"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>PartitionValues</b> (<a class="el" href="classiceberg_1_1PartitionValues.html">PartitionValues</a> &amp;&amp;) noexcept=default</td></tr>
<tr class="separator:a67802745bb2255cee1d4c22d718fa168"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a824b8ae72219dcc52915763b531dd0" id="r_a1a824b8ae72219dcc52915763b531dd0"><td class="memItemLeft" align="right" valign="top"><a id="a1a824b8ae72219dcc52915763b531dd0" name="a1a824b8ae72219dcc52915763b531dd0"></a>
<a class="el" href="classiceberg_1_1PartitionValues.html">PartitionValues</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classiceberg_1_1PartitionValues.html">PartitionValues</a> &amp;&amp;) noexcept=default</td></tr>
<tr class="separator:a1a824b8ae72219dcc52915763b531dd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e4f25e83c939e00bc2e11cef55754c7" id="r_a0e4f25e83c939e00bc2e11cef55754c7"><td class="memItemLeft" align="right" valign="top">Result&lt; <a class="el" href="struct__like_8h.html#a3b5162f202989971e28bc310237964db">Scalar</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1PartitionValues.html#a0e4f25e83c939e00bc2e11cef55754c7">GetField</a> (size_t pos) const override</td></tr>
<tr class="memdesc:a0e4f25e83c939e00bc2e11cef55754c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the field value at the given position. <br /></td></tr>
<tr class="separator:a0e4f25e83c939e00bc2e11cef55754c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ac3c4a2e24db605edb3c5a515102fa7" id="r_a9ac3c4a2e24db605edb3c5a515102fa7"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1PartitionValues.html#a9ac3c4a2e24db605edb3c5a515102fa7">num_fields</a> () const override</td></tr>
<tr class="memdesc:a9ac3c4a2e24db605edb3c5a515102fa7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number of fields in the struct. <br /></td></tr>
<tr class="separator:a9ac3c4a2e24db605edb3c5a515102fa7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a67fc6f7552b8e38b35011b6c0648959d" id="r_a67fc6f7552b8e38b35011b6c0648959d"><td class="memItemLeft" align="right" valign="top">Result&lt; std::reference_wrapper&lt; const <a class="el" href="classiceberg_1_1Literal.html">Literal</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1PartitionValues.html#a67fc6f7552b8e38b35011b6c0648959d">ValueAt</a> (size_t pos) const</td></tr>
<tr class="memdesc:a67fc6f7552b8e38b35011b6c0648959d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the partition field value at the given position. <br /></td></tr>
<tr class="separator:a67fc6f7552b8e38b35011b6c0648959d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af07e2264eacb417a3a351ac8ba3403ab" id="r_af07e2264eacb417a3a351ac8ba3403ab"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1PartitionValues.html#af07e2264eacb417a3a351ac8ba3403ab">AddValue</a> (<a class="el" href="classiceberg_1_1Literal.html">Literal</a> value)</td></tr>
<tr class="memdesc:af07e2264eacb417a3a351ac8ba3403ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a value to the partition values. <br /></td></tr>
<tr class="separator:af07e2264eacb417a3a351ac8ba3403ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7572b79322554b4dea4eaf3f691be635" id="r_a7572b79322554b4dea4eaf3f691be635"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1PartitionValues.html#a7572b79322554b4dea4eaf3f691be635">Reset</a> (std::vector&lt; <a class="el" href="classiceberg_1_1Literal.html">Literal</a> &gt; values)</td></tr>
<tr class="memdesc:a7572b79322554b4dea4eaf3f691be635"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the partition values. <br /></td></tr>
<tr class="separator:a7572b79322554b4dea4eaf3f691be635"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a770e2b0c7197b7ee8f38823eb9a10758" id="r_a770e2b0c7197b7ee8f38823eb9a10758"><td class="memItemLeft" align="right" valign="top"><a id="a770e2b0c7197b7ee8f38823eb9a10758" name="a770e2b0c7197b7ee8f38823eb9a10758"></a>
std::span&lt; const <a class="el" href="classiceberg_1_1Literal.html">Literal</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>values</b> () const</td></tr>
<tr class="separator:a770e2b0c7197b7ee8f38823eb9a10758"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af37b9443eb2210d7f6270e08d7dd0c81" id="r_af37b9443eb2210d7f6270e08d7dd0c81"><td class="memItemLeft" align="right" valign="top"><a id="af37b9443eb2210d7f6270e08d7dd0c81" name="af37b9443eb2210d7f6270e08d7dd0c81"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="classiceberg_1_1PartitionValues.html">PartitionValues</a> &amp;other) const</td></tr>
<tr class="separator:af37b9443eb2210d7f6270e08d7dd0c81"><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 class="el" href="classiceberg_1_1StructLike.html" title="An immutable struct-like wrapper.">StructLike</a> wrapper for a vector of literals that represent partition values. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="af07e2264eacb417a3a351ac8ba3403ab" name="af07e2264eacb417a3a351ac8ba3403ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af07e2264eacb417a3a351ac8ba3403ab">&#9670;&#160;</a></span>AddValue()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void iceberg::PartitionValues::AddValue </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classiceberg_1_1Literal.html">Literal</a>&#160;</td>
<td class="paramname"><em>value</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>Add a value to the partition values. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>The value to add. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0e4f25e83c939e00bc2e11cef55754c7" name="a0e4f25e83c939e00bc2e11cef55754c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e4f25e83c939e00bc2e11cef55754c7">&#9670;&#160;</a></span>GetField()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Result&lt; <a class="el" href="struct__like_8h.html#a3b5162f202989971e28bc310237964db">Scalar</a> &gt; iceberg::PartitionValues::GetField </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>pos</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the field value at the given position. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pos</td><td>The position of the field in the struct. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classiceberg_1_1StructLike.html#a1bed712ac299583f54ad2fcd91087e11">iceberg::StructLike</a>.</p>
</div>
</div>
<a id="a9ac3c4a2e24db605edb3c5a515102fa7" name="a9ac3c4a2e24db605edb3c5a515102fa7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ac3c4a2e24db605edb3c5a515102fa7">&#9670;&#160;</a></span>num_fields()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t iceberg::PartitionValues::num_fields </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of fields in the struct. </p>
<p>Implements <a class="el" href="classiceberg_1_1StructLike.html#a3c9041a832eb91386eaf51753d745914">iceberg::StructLike</a>.</p>
</div>
</div>
<a id="a7572b79322554b4dea4eaf3f691be635" name="a7572b79322554b4dea4eaf3f691be635"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7572b79322554b4dea4eaf3f691be635">&#9670;&#160;</a></span>Reset()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void iceberg::PartitionValues::Reset </td>
<td>(</td>
<td class="paramtype">std::vector&lt; <a class="el" href="classiceberg_1_1Literal.html">Literal</a> &gt;&#160;</td>
<td class="paramname"><em>values</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>Reset the partition values. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">values</td><td>The values to reset to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a67fc6f7552b8e38b35011b6c0648959d" name="a67fc6f7552b8e38b35011b6c0648959d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67fc6f7552b8e38b35011b6c0648959d">&#9670;&#160;</a></span>ValueAt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Result&lt; std::reference_wrapper&lt; const <a class="el" href="classiceberg_1_1Literal.html">Literal</a> &gt; &gt; iceberg::PartitionValues::ValueAt </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>pos</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the partition field value at the given position. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pos</td><td>The position of the field in the struct. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A reference to the partition field value. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>iceberg/row/<a class="el" href="partition__values_8h_source.html">partition_values.h</a></li>
<li>iceberg/row/<b>partition_values.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>