Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./mkdocs/docs/api/classiceberg_1_1MapLike.html
blob: 5968fda0dd612471fc0e0285e9c59e19cfb50ec6 [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::MapLike 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_1MapLike.html">MapLike</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_1MapLike-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::MapLike Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>An immutable map-like wrapper.
<a href="classiceberg_1_1MapLike.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="struct__like_8h_source.html">struct_like.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for iceberg::MapLike:</div>
<div class="dyncontent">
<div class="center">
<img src="classiceberg_1_1MapLike.png" usemap="#iceberg::MapLike_map" alt=""/>
<map id="iceberg::MapLike_map" name="iceberg::MapLike_map">
<area href="classiceberg_1_1ArrowArrayMapLike.html" title="Wrapper for one row of a map-typed ArrowArray." alt="iceberg::ArrowArrayMapLike" shape="rect" coords="0,56,177,80"/>
</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:aefb93debfcbe52e3223ee36bf2345b6f" id="r_aefb93debfcbe52e3223ee36bf2345b6f"><td class="memItemLeft" align="right" valign="top">virtual 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_1MapLike.html#aefb93debfcbe52e3223ee36bf2345b6f">GetKey</a> (size_t pos) const =0</td></tr>
<tr class="memdesc:aefb93debfcbe52e3223ee36bf2345b6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the key at the given position. <br /></td></tr>
<tr class="separator:aefb93debfcbe52e3223ee36bf2345b6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add2591f25282d409167352bbb1c5e558" id="r_add2591f25282d409167352bbb1c5e558"><td class="memItemLeft" align="right" valign="top">virtual 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_1MapLike.html#add2591f25282d409167352bbb1c5e558">GetValue</a> (size_t pos) const =0</td></tr>
<tr class="memdesc:add2591f25282d409167352bbb1c5e558"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value at the given position. <br /></td></tr>
<tr class="separator:add2591f25282d409167352bbb1c5e558"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d769b5646f089820800c321bec7f2f6" id="r_a9d769b5646f089820800c321bec7f2f6"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1MapLike.html#a9d769b5646f089820800c321bec7f2f6">size</a> () const =0</td></tr>
<tr class="memdesc:a9d769b5646f089820800c321bec7f2f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number of entries in the map. <br /></td></tr>
<tr class="separator:a9d769b5646f089820800c321bec7f2f6"><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>An immutable map-like wrapper. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aefb93debfcbe52e3223ee36bf2345b6f" name="aefb93debfcbe52e3223ee36bf2345b6f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aefb93debfcbe52e3223ee36bf2345b6f">&#9670;&#160;</a></span>GetKey()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual Result&lt; <a class="el" href="struct__like_8h.html#a3b5162f202989971e28bc310237964db">Scalar</a> &gt; iceberg::MapLike::GetKey </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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the key 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 key in the map. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classiceberg_1_1ArrowArrayMapLike.html#ab6122b7ece0ce63e851a3fa264a930c5">iceberg::ArrowArrayMapLike</a>.</p>
</div>
</div>
<a id="add2591f25282d409167352bbb1c5e558" name="add2591f25282d409167352bbb1c5e558"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add2591f25282d409167352bbb1c5e558">&#9670;&#160;</a></span>GetValue()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual Result&lt; <a class="el" href="struct__like_8h.html#a3b5162f202989971e28bc310237964db">Scalar</a> &gt; iceberg::MapLike::GetValue </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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the 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 value in the map. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classiceberg_1_1ArrowArrayMapLike.html#a2b8b3eded23593478824d4888f5b3342">iceberg::ArrowArrayMapLike</a>.</p>
</div>
</div>
<a id="a9d769b5646f089820800c321bec7f2f6" name="a9d769b5646f089820800c321bec7f2f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d769b5646f089820800c321bec7f2f6">&#9670;&#160;</a></span>size()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t iceberg::MapLike::size </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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of entries in the map. </p>
<p>Implemented in <a class="el" href="classiceberg_1_1ArrowArrayMapLike.html#a36ca31afe3fb870a15a5222eecd35697">iceberg::ArrowArrayMapLike</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>iceberg/row/<a class="el" href="struct__like_8h_source.html">struct_like.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>