Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./mkdocs/docs/api/classiceberg_1_1BoundTerm.html
blob: 2c5a0e26b96ad713ad58a9dbd350880d5be72c94 [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::BoundTerm 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_1BoundTerm.html">BoundTerm</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classiceberg_1_1BoundTerm-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::BoundTerm Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Base class for bound terms.
<a href="classiceberg_1_1BoundTerm.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="term_8h_source.html">term.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for iceberg::BoundTerm:</div>
<div class="dyncontent">
<div class="center">
<img src="classiceberg_1_1BoundTerm.png" usemap="#iceberg::BoundTerm_map" alt=""/>
<map id="iceberg::BoundTerm_map" name="iceberg::BoundTerm_map">
<area href="classiceberg_1_1Bound.html" title="Interface for bound expressions that can be evaluated." alt="iceberg::Bound" shape="rect" coords="0,56,156,80"/>
<area href="classiceberg_1_1Term.html" title="A term is an expression node that produces a typed value when evaluated." alt="iceberg::Term" shape="rect" coords="166,56,322,80"/>
<area href="classiceberg_1_1util_1_1Formattable.html" title="Interface for objects that can be formatted via std::format." alt="iceberg::util::Formattable" shape="rect" coords="166,0,322,24"/>
<area href="classiceberg_1_1BoundReference.html" title="A reference to a bound field." alt="iceberg::BoundReference" shape="rect" coords="0,168,156,192"/>
<area href="classiceberg_1_1BoundTransform.html" title="A bound transform expression." alt="iceberg::BoundTransform" shape="rect" coords="166,168,322,192"/>
</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:a4a1cdc1d333514ba2d5cc25c044452d6" id="r_a4a1cdc1d333514ba2d5cc25c044452d6"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Type.html">Type</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1BoundTerm.html#a4a1cdc1d333514ba2d5cc25c044452d6">type</a> () const =0</td></tr>
<tr class="memdesc:a4a1cdc1d333514ba2d5cc25c044452d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the type produced by this term. <br /></td></tr>
<tr class="separator:a4a1cdc1d333514ba2d5cc25c044452d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abffaa202fd9200fcefc17dd3d1464748" id="r_abffaa202fd9200fcefc17dd3d1464748"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1BoundTerm.html#abffaa202fd9200fcefc17dd3d1464748">MayProduceNull</a> () const =0</td></tr>
<tr class="memdesc:abffaa202fd9200fcefc17dd3d1464748"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether this term may produce null values. <br /></td></tr>
<tr class="separator:abffaa202fd9200fcefc17dd3d1464748"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f4726d7e71a9032408a7c6a196618a0" id="r_a9f4726d7e71a9032408a7c6a196618a0"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1BoundTerm.html#a9f4726d7e71a9032408a7c6a196618a0">Equals</a> (const <a class="el" href="classiceberg_1_1BoundTerm.html">BoundTerm</a> &amp;other) const =0</td></tr>
<tr class="memdesc:a9f4726d7e71a9032408a7c6a196618a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether this term is equivalent to another. <br /></td></tr>
<tr class="separator:a9f4726d7e71a9032408a7c6a196618a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74959f3a65f7a8fcf9f11e0b23f05e58" id="r_a74959f3a65f7a8fcf9f11e0b23f05e58"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1BoundTerm.html#a74959f3a65f7a8fcf9f11e0b23f05e58">is_unbound</a> () const override</td></tr>
<tr class="memdesc:a74959f3a65f7a8fcf9f11e0b23f05e58"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether this term is unbound. <br /></td></tr>
<tr class="separator:a74959f3a65f7a8fcf9f11e0b23f05e58"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classiceberg_1_1Bound"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classiceberg_1_1Bound')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classiceberg_1_1Bound.html">iceberg::Bound</a></td></tr>
<tr class="memitem:ae3accf6c583a065d2bb6b47cdcbac1c3 inherit pub_methods_classiceberg_1_1Bound" id="r_ae3accf6c583a065d2bb6b47cdcbac1c3"><td class="memItemLeft" align="right" valign="top">virtual Result&lt; <a class="el" href="classiceberg_1_1Literal.html">Literal</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Bound.html#ae3accf6c583a065d2bb6b47cdcbac1c3">Evaluate</a> (const <a class="el" href="classiceberg_1_1StructLike.html">StructLike</a> &amp;data) const =0</td></tr>
<tr class="memdesc:ae3accf6c583a065d2bb6b47cdcbac1c3 inherit pub_methods_classiceberg_1_1Bound"><td class="mdescLeft">&#160;</td><td class="mdescRight">Evaluate this expression against a row-based data. <br /></td></tr>
<tr class="separator:ae3accf6c583a065d2bb6b47cdcbac1c3 inherit pub_methods_classiceberg_1_1Bound"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80f0b389e0244809527168fca111a0a6 inherit pub_methods_classiceberg_1_1Bound" id="r_a80f0b389e0244809527168fca111a0a6"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr&lt; class <a class="el" href="classiceberg_1_1BoundReference.html">BoundReference</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Bound.html#a80f0b389e0244809527168fca111a0a6">reference</a> ()=0</td></tr>
<tr class="memdesc:a80f0b389e0244809527168fca111a0a6 inherit pub_methods_classiceberg_1_1Bound"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the underlying bound reference for this term. <br /></td></tr>
<tr class="separator:a80f0b389e0244809527168fca111a0a6 inherit pub_methods_classiceberg_1_1Bound"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classiceberg_1_1Term"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classiceberg_1_1Term')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classiceberg_1_1Term.html">iceberg::Term</a></td></tr>
<tr class="memitem:abc8368a414f930269b883a090869eb14 inherit pub_methods_classiceberg_1_1Term" id="r_abc8368a414f930269b883a090869eb14"><td class="memItemLeft" align="right" valign="top">virtual Kind&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Term.html#abc8368a414f930269b883a090869eb14">kind</a> () const =0</td></tr>
<tr class="memdesc:abc8368a414f930269b883a090869eb14 inherit pub_methods_classiceberg_1_1Term"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the kind of this term. <br /></td></tr>
<tr class="separator:abc8368a414f930269b883a090869eb14 inherit pub_methods_classiceberg_1_1Term"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classiceberg_1_1util_1_1Formattable"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classiceberg_1_1util_1_1Formattable')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classiceberg_1_1util_1_1Formattable.html">iceberg::util::Formattable</a></td></tr>
<tr class="memitem:a79618aca5b3bf63610d9c87ac5ae0386 inherit pub_methods_classiceberg_1_1util_1_1Formattable" id="r_a79618aca5b3bf63610d9c87ac5ae0386"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1util_1_1Formattable.html#a79618aca5b3bf63610d9c87ac5ae0386">ToString</a> () const =0</td></tr>
<tr class="memdesc:a79618aca5b3bf63610d9c87ac5ae0386 inherit pub_methods_classiceberg_1_1util_1_1Formattable"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a user-readable string representation. <br /></td></tr>
<tr class="separator:a79618aca5b3bf63610d9c87ac5ae0386 inherit pub_methods_classiceberg_1_1util_1_1Formattable"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:ada4b77b71abe982bc80245205a1825c0" id="r_ada4b77b71abe982bc80245205a1825c0"><td class="memItemLeft" align="right" valign="top"><a id="ada4b77b71abe982bc80245205a1825c0" name="ada4b77b71abe982bc80245205a1825c0"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="classiceberg_1_1BoundTerm.html">BoundTerm</a> &amp;lhs, const <a class="el" href="classiceberg_1_1BoundTerm.html">BoundTerm</a> &amp;rhs)</td></tr>
<tr class="separator:ada4b77b71abe982bc80245205a1825c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_classiceberg_1_1Term"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classiceberg_1_1Term')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classiceberg_1_1Term.html">iceberg::Term</a></td></tr>
<tr class="memitem:aafdab7cb8b14117f662d394450af6be8 inherit pub_types_classiceberg_1_1Term" id="r_aafdab7cb8b14117f662d394450af6be8"><td class="memItemLeft" align="right" valign="top"><a id="aafdab7cb8b14117f662d394450af6be8" name="aafdab7cb8b14117f662d394450af6be8"></a>enum class &#160;</td><td class="memItemRight" valign="bottom"><b>Kind</b> : uint8_t { <b>kReference</b>
, <b>kTransform</b>
, <b>kExtract</b>
}</td></tr>
<tr class="separator:aafdab7cb8b14117f662d394450af6be8 inherit pub_types_classiceberg_1_1Term"><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>Base class for bound terms. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a9f4726d7e71a9032408a7c6a196618a0" name="a9f4726d7e71a9032408a7c6a196618a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f4726d7e71a9032408a7c6a196618a0">&#9670;&#160;</a></span>Equals()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool iceberg::BoundTerm::Equals </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classiceberg_1_1BoundTerm.html">BoundTerm</a> &amp;&#160;</td>
<td class="paramname"><em>other</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>Returns whether this term is equivalent to another. </p>
<p>Two terms are equivalent if they produce the same values when evaluated.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>Another bound term to compare against </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the terms are equivalent, false otherwise </dd></dl>
<p>Implemented in <a class="el" href="classiceberg_1_1BoundReference.html#a7ea16cba6f701f87ca07438593a97078">iceberg::BoundReference</a>, and <a class="el" href="classiceberg_1_1BoundTransform.html#aa639d4379735d306c14c2eb06e5ab47f">iceberg::BoundTransform</a>.</p>
</div>
</div>
<a id="a74959f3a65f7a8fcf9f11e0b23f05e58" name="a74959f3a65f7a8fcf9f11e0b23f05e58"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a74959f3a65f7a8fcf9f11e0b23f05e58">&#9670;&#160;</a></span>is_unbound()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool iceberg::BoundTerm::is_unbound </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>Returns whether this term is unbound. </p>
<p>Implements <a class="el" href="classiceberg_1_1Term.html#a14267bbe97519bec67cec9c4ca569090">iceberg::Term</a>.</p>
</div>
</div>
<a id="abffaa202fd9200fcefc17dd3d1464748" name="abffaa202fd9200fcefc17dd3d1464748"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abffaa202fd9200fcefc17dd3d1464748">&#9670;&#160;</a></span>MayProduceNull()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool iceberg::BoundTerm::MayProduceNull </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>Returns whether this term may produce null values. </p>
<p>Implemented in <a class="el" href="classiceberg_1_1BoundReference.html#a136c61fca8dd7ac25e2226bd0a3fd81d">iceberg::BoundReference</a>, and <a class="el" href="classiceberg_1_1BoundTransform.html#ab309e6e81dd1c49d35955bee66cd590d">iceberg::BoundTransform</a>.</p>
</div>
</div>
<a id="a4a1cdc1d333514ba2d5cc25c044452d6" name="a4a1cdc1d333514ba2d5cc25c044452d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a1cdc1d333514ba2d5cc25c044452d6">&#9670;&#160;</a></span>type()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Type.html">Type</a> &gt; iceberg::BoundTerm::type </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>Returns the type produced by this term. </p>
<p>Implemented in <a class="el" href="classiceberg_1_1BoundReference.html#a8bc782eceb6bfc0868e26b8b895b2fb8">iceberg::BoundReference</a>, and <a class="el" href="classiceberg_1_1BoundTransform.html#a3df2176957c730e57d1675369add8a47">iceberg::BoundTransform</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>iceberg/expression/<a class="el" href="term_8h_source.html">term.h</a></li>
<li>iceberg/expression/<b>term.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>