Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./mkdocs/docs/api/classiceberg_1_1False.html
blob: bd82c4b08debd81f179daf2ed3a0fc41143961ef [file]
<!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::False 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_1False.html">False</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classiceberg_1_1False-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::False Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>An expression that is always false.
<a href="classiceberg_1_1False.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="expression_8h_source.html">expression.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for iceberg::False:</div>
<div class="dyncontent">
<div class="center">
<img src="classiceberg_1_1False.png" usemap="#iceberg::False_map" alt=""/>
<map id="iceberg::False_map" name="iceberg::False_map">
<area href="classiceberg_1_1Expression.html" title="Represents a boolean expression tree." alt="iceberg::Expression" shape="rect" coords="0,56,149,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="0,0,149,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:aaccc2ef838f10e74398e471743e6fb23" id="r_aaccc2ef838f10e74398e471743e6fb23"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classiceberg_1_1Expression.html#a433076bdc34ce0b6d359313c6c7b8a9c">Operation</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1False.html#aaccc2ef838f10e74398e471743e6fb23">op</a> () const override</td></tr>
<tr class="memdesc:aaccc2ef838f10e74398e471743e6fb23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the operation for an expression node. <br /></td></tr>
<tr class="separator:aaccc2ef838f10e74398e471743e6fb23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c87482982da354f63c8b09bab9bde35" id="r_a7c87482982da354f63c8b09bab9bde35"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1False.html#a7c87482982da354f63c8b09bab9bde35">ToString</a> () const override</td></tr>
<tr class="memdesc:a7c87482982da354f63c8b09bab9bde35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a user-readable string representation. <br /></td></tr>
<tr class="separator:a7c87482982da354f63c8b09bab9bde35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f3630c6ec3a6a4eef65f3e680628004" id="r_a8f3630c6ec3a6a4eef65f3e680628004"><td class="memItemLeft" align="right" valign="top">Result&lt; std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Expression.html">Expression</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1False.html#a8f3630c6ec3a6a4eef65f3e680628004">Negate</a> () const override</td></tr>
<tr class="memdesc:a8f3630c6ec3a6a4eef65f3e680628004"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the negation of this expression, equivalent to not(this). <br /></td></tr>
<tr class="separator:a8f3630c6ec3a6a4eef65f3e680628004"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aabcd9ebfb3e6cec22fa5bd45aedfacc6" id="r_aabcd9ebfb3e6cec22fa5bd45aedfacc6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1False.html#aabcd9ebfb3e6cec22fa5bd45aedfacc6">Equals</a> (const <a class="el" href="classiceberg_1_1Expression.html">Expression</a> &amp;other) const override</td></tr>
<tr class="memdesc:aabcd9ebfb3e6cec22fa5bd45aedfacc6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether this expression will accept the same values as another. <br /></td></tr>
<tr class="separator:aabcd9ebfb3e6cec22fa5bd45aedfacc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classiceberg_1_1Expression"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classiceberg_1_1Expression')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classiceberg_1_1Expression.html">iceberg::Expression</a></td></tr>
<tr class="memitem:a96e614d02433117161d21989f7ff1257 inherit pub_methods_classiceberg_1_1Expression" id="r_a96e614d02433117161d21989f7ff1257"><td class="memItemLeft" align="right" valign="top">
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>is_unbound_predicate</b> () const</td></tr>
<tr class="separator:a96e614d02433117161d21989f7ff1257 inherit pub_methods_classiceberg_1_1Expression"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8807793506a834a71384dac034e6c62f inherit pub_methods_classiceberg_1_1Expression" id="r_a8807793506a834a71384dac034e6c62f"><td class="memItemLeft" align="right" valign="top">
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>is_bound_predicate</b> () const</td></tr>
<tr class="separator:a8807793506a834a71384dac034e6c62f inherit pub_methods_classiceberg_1_1Expression"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d17c720a2f03ee4924b8c36f0420ff1 inherit pub_methods_classiceberg_1_1Expression" id="r_a9d17c720a2f03ee4924b8c36f0420ff1"><td class="memItemLeft" align="right" valign="top">
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>is_unbound_aggregate</b> () const</td></tr>
<tr class="separator:a9d17c720a2f03ee4924b8c36f0420ff1 inherit pub_methods_classiceberg_1_1Expression"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab760f80ffc03ab40301be7d59c621a4a inherit pub_methods_classiceberg_1_1Expression" id="r_ab760f80ffc03ab40301be7d59c621a4a"><td class="memItemLeft" align="right" valign="top">
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>is_bound_aggregate</b> () const</td></tr>
<tr class="separator:ab760f80ffc03ab40301be7d59c621a4a inherit pub_methods_classiceberg_1_1Expression"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a2e7ef9efa2bfb8a83a66a06cafd54880" id="r_a2e7ef9efa2bfb8a83a66a06cafd54880"><td class="memItemLeft" align="right" valign="top"><a id="a2e7ef9efa2bfb8a83a66a06cafd54880" name="a2e7ef9efa2bfb8a83a66a06cafd54880"></a>
static const std::shared_ptr&lt; <a class="el" href="classiceberg_1_1False.html">False</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>Instance</b> ()</td></tr>
<tr class="memdesc:a2e7ef9efa2bfb8a83a66a06cafd54880"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the singleton instance. <br /></td></tr>
<tr class="separator:a2e7ef9efa2bfb8a83a66a06cafd54880"><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_1Expression"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classiceberg_1_1Expression')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classiceberg_1_1Expression.html">iceberg::Expression</a></td></tr>
<tr class="memitem:a433076bdc34ce0b6d359313c6c7b8a9c inherit pub_types_classiceberg_1_1Expression" id="r_a433076bdc34ce0b6d359313c6c7b8a9c"><td class="memItemLeft" align="right" valign="top"><a id="a433076bdc34ce0b6d359313c6c7b8a9c" name="a433076bdc34ce0b6d359313c6c7b8a9c"></a>enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Expression.html#a433076bdc34ce0b6d359313c6c7b8a9c">Operation</a> { <br />
&#160;&#160;<b>kTrue</b>
, <b>kFalse</b>
, <b>kIsNull</b>
, <b>kNotNull</b>
, <br />
&#160;&#160;<b>kIsNan</b>
, <b>kNotNan</b>
, <b>kLt</b>
, <b>kLtEq</b>
, <br />
&#160;&#160;<b>kGt</b>
, <b>kGtEq</b>
, <b>kEq</b>
, <b>kNotEq</b>
, <br />
&#160;&#160;<b>kIn</b>
, <b>kNotIn</b>
, <b>kNot</b>
, <b>kAnd</b>
, <br />
&#160;&#160;<b>kOr</b>
, <b>kStartsWith</b>
, <b>kNotStartsWith</b>
, <b>kCount</b>
, <br />
&#160;&#160;<b>kCountNull</b>
, <b>kCountStar</b>
, <b>kMax</b>
, <b>kMin</b>
<br />
}</td></tr>
<tr class="memdesc:a433076bdc34ce0b6d359313c6c7b8a9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operation types for expressions. <br /></td></tr>
<tr class="separator:a433076bdc34ce0b6d359313c6c7b8a9c inherit pub_types_classiceberg_1_1Expression"><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 expression that is always false. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aabcd9ebfb3e6cec22fa5bd45aedfacc6" name="aabcd9ebfb3e6cec22fa5bd45aedfacc6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aabcd9ebfb3e6cec22fa5bd45aedfacc6">&#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">bool iceberg::False::Equals </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classiceberg_1_1Expression.html">Expression</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">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns whether this expression will accept the same values as another. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>another expression </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the expressions are equivalent </dd></dl>
<p>Reimplemented from <a class="el" href="classiceberg_1_1Expression.html#a5f62190ba4e74757afb0fba05acb1e6a">iceberg::Expression</a>.</p>
</div>
</div>
<a id="a8f3630c6ec3a6a4eef65f3e680628004" name="a8f3630c6ec3a6a4eef65f3e680628004"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f3630c6ec3a6a4eef65f3e680628004">&#9670;&#160;</a></span>Negate()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Result&lt; std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Expression.html">Expression</a> &gt; &gt; iceberg::False::Negate </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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the negation of this expression, equivalent to not(this). </p>
<p>Reimplemented from <a class="el" href="classiceberg_1_1Expression.html#a7ce9433b8cc063b06ac6371d6d56815c">iceberg::Expression</a>.</p>
</div>
</div>
<a id="aaccc2ef838f10e74398e471743e6fb23" name="aaccc2ef838f10e74398e471743e6fb23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaccc2ef838f10e74398e471743e6fb23">&#9670;&#160;</a></span>op()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classiceberg_1_1Expression.html#a433076bdc34ce0b6d359313c6c7b8a9c">Operation</a> iceberg::False::op </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 the operation for an expression node. </p>
<p>Implements <a class="el" href="classiceberg_1_1Expression.html#a5a16ee5d023305b50e4a2216b4047eff">iceberg::Expression</a>.</p>
</div>
</div>
<a id="a7c87482982da354f63c8b09bab9bde35" name="a7c87482982da354f63c8b09bab9bde35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c87482982da354f63c8b09bab9bde35">&#9670;&#160;</a></span>ToString()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string iceberg::False::ToString </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 a user-readable string representation. </p>
<p>Reimplemented from <a class="el" href="classiceberg_1_1Expression.html#a2e9c204f698d069ebc0fefb9e5269ab6">iceberg::Expression</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>iceberg/expression/<a class="el" href="expression_8h_source.html">expression.h</a></li>
<li>iceberg/expression/<b>expression.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>