blob: 2e75d21f86976de50528710df19c81c1b97fa9bf [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>Paimon-cpp: paimon::Function 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">Paimon-cpp
</div>
<div id="projectbrief">A high-performance C++ implementation of Apache Paimon</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"><a class="el" href="namespacepaimon.html">paimon</a></li><li class="navelem"><a class="el" href="classpaimon_1_1_function.html">Function</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="classpaimon_1_1_function-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">paimon::Function Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p><code><a class="el" href="classpaimon_1_1_function.html" title="Function represents a predicate function used in query expressions and filtering operations.">Function</a></code> represents a predicate function used in query expressions and filtering operations.
<a href="classpaimon_1_1_function.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="function_8h_source.html">/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/predicate/function.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:aa863a7d5f36a89c6765ea0118bb9a1dc" id="r_aa863a7d5f36a89c6765ea0118bb9a1dc"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_function.html#aa863a7d5f36a89c6765ea0118bb9a1dc">Type</a> { <br />
&#160;&#160;<a class="el" href="classpaimon_1_1_function.html#aa863a7d5f36a89c6765ea0118bb9a1dcadbd9c38e0339e6c34bd48cafc59be388">IS_NULL</a> = 1
, <a class="el" href="classpaimon_1_1_function.html#aa863a7d5f36a89c6765ea0118bb9a1dca05dd132ba23ff57c0ca5ec4100c31fdc">IS_NOT_NULL</a> = 2
, <a class="el" href="classpaimon_1_1_function.html#aa863a7d5f36a89c6765ea0118bb9a1dca969f331a87d8c958473c32b4d0e61a44">EQUAL</a> = 3
, <a class="el" href="classpaimon_1_1_function.html#aa863a7d5f36a89c6765ea0118bb9a1dca4ea2d378cdec20f59330f113297bc1ce">NOT_EQUAL</a> = 4
, <br />
&#160;&#160;<a class="el" href="classpaimon_1_1_function.html#aa863a7d5f36a89c6765ea0118bb9a1dca1625ef4fe09f68fa20d3ff6e02cd5c8e">GREATER_THAN</a> = 5
, <a class="el" href="classpaimon_1_1_function.html#aa863a7d5f36a89c6765ea0118bb9a1dcaa6872139811c4046ad15aa6763956a4f">GREATER_OR_EQUAL</a> = 6
, <a class="el" href="classpaimon_1_1_function.html#aa863a7d5f36a89c6765ea0118bb9a1dcaa327176a0a845c117bdfadec134a95e9">LESS_THAN</a> = 7
, <a class="el" href="classpaimon_1_1_function.html#aa863a7d5f36a89c6765ea0118bb9a1dca93d39e6064b3c462e437e20cd8b2bdab">LESS_OR_EQUAL</a> = 8
, <br />
&#160;&#160;<a class="el" href="classpaimon_1_1_function.html#aa863a7d5f36a89c6765ea0118bb9a1dcac86ee0d9d7ed3e7b4fdbf486fa6c0ebb">IN</a> = 9
, <a class="el" href="classpaimon_1_1_function.html#aa863a7d5f36a89c6765ea0118bb9a1dcaf43267050fc487181424367e8496f2f9">NOT_IN</a> = 10
, <a class="el" href="classpaimon_1_1_function.html#aa863a7d5f36a89c6765ea0118bb9a1dca558ffc8f5770d8e4f95f51d822685532">AND</a> = 11
, <a class="el" href="classpaimon_1_1_function.html#aa863a7d5f36a89c6765ea0118bb9a1dca1d00e7dce692e8dc3f6877f035e3a616">OR</a> = 12
, <br />
&#160;&#160;<a class="el" href="classpaimon_1_1_function.html#aa863a7d5f36a89c6765ea0118bb9a1dca1a1fe0fcacfcb22095aee25fa9c20ec1">STARTS_WITH</a> = 13
, <a class="el" href="classpaimon_1_1_function.html#aa863a7d5f36a89c6765ea0118bb9a1dca6db8b119b8d5008ca2f87d883bfff185">ENDS_WITH</a> = 14
, <a class="el" href="classpaimon_1_1_function.html#aa863a7d5f36a89c6765ea0118bb9a1dca7c8b81e077a45b6d2c9c03d3a22c0d5b">CONTAINS</a> = 15
, <a class="el" href="classpaimon_1_1_function.html#aa863a7d5f36a89c6765ea0118bb9a1dcaa7598964efa10e649f92662b79e8d4d3">LIKE</a> = 16
<br />
}</td></tr>
<tr class="separator:aa863a7d5f36a89c6765ea0118bb9a1dc"><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:a56c7c5f77f752fe739c9560bac08ed22" id="r_a56c7c5f77f752fe739c9560bac08ed22"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">virtual</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_function.html#a56c7c5f77f752fe739c9560bac08ed22">~Function</a> ()=<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">default</a></td></tr>
<tr class="separator:a56c7c5f77f752fe739c9560bac08ed22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21935cc8cd44b2734f8ab6fb8e8143db" id="r_a21935cc8cd44b2734f8ab6fb8e8143db"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">virtual</a> <a class="el" href="classpaimon_1_1_function.html#aa863a7d5f36a89c6765ea0118bb9a1dc">Type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_function.html#a21935cc8cd44b2734f8ab6fb8e8143db">GetType</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> =0</td></tr>
<tr class="separator:a21935cc8cd44b2734f8ab6fb8e8143db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7cd256e7c828b608245e3e9a7e8c3e8" id="r_aa7cd256e7c828b608245e3e9a7e8c3e8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">virtual</a> std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_function.html#aa7cd256e7c828b608245e3e9a7e8c3e8">ToString</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> =0</td></tr>
<tr class="separator:aa7cd256e7c828b608245e3e9a7e8c3e8"><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><code><a class="el" href="classpaimon_1_1_function.html" title="Function represents a predicate function used in query expressions and filtering operations.">Function</a></code> represents a predicate function used in query expressions and filtering operations. </p>
<p>It serves as the base class for all predicate functions in Paimon. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="aa863a7d5f36a89c6765ea0118bb9a1dc" name="aa863a7d5f36a89c6765ea0118bb9a1dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa863a7d5f36a89c6765ea0118bb9a1dc">&#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"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">enum</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">class</a> <a class="el" href="classpaimon_1_1_function.html#aa863a7d5f36a89c6765ea0118bb9a1dc">paimon::Function::Type</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aa863a7d5f36a89c6765ea0118bb9a1dcadbd9c38e0339e6c34bd48cafc59be388" name="aa863a7d5f36a89c6765ea0118bb9a1dcadbd9c38e0339e6c34bd48cafc59be388"></a>IS_NULL&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aa863a7d5f36a89c6765ea0118bb9a1dca05dd132ba23ff57c0ca5ec4100c31fdc" name="aa863a7d5f36a89c6765ea0118bb9a1dca05dd132ba23ff57c0ca5ec4100c31fdc"></a>IS_NOT_NULL&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aa863a7d5f36a89c6765ea0118bb9a1dca969f331a87d8c958473c32b4d0e61a44" name="aa863a7d5f36a89c6765ea0118bb9a1dca969f331a87d8c958473c32b4d0e61a44"></a>EQUAL&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aa863a7d5f36a89c6765ea0118bb9a1dca4ea2d378cdec20f59330f113297bc1ce" name="aa863a7d5f36a89c6765ea0118bb9a1dca4ea2d378cdec20f59330f113297bc1ce"></a>NOT_EQUAL&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aa863a7d5f36a89c6765ea0118bb9a1dca1625ef4fe09f68fa20d3ff6e02cd5c8e" name="aa863a7d5f36a89c6765ea0118bb9a1dca1625ef4fe09f68fa20d3ff6e02cd5c8e"></a>GREATER_THAN&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aa863a7d5f36a89c6765ea0118bb9a1dcaa6872139811c4046ad15aa6763956a4f" name="aa863a7d5f36a89c6765ea0118bb9a1dcaa6872139811c4046ad15aa6763956a4f"></a>GREATER_OR_EQUAL&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aa863a7d5f36a89c6765ea0118bb9a1dcaa327176a0a845c117bdfadec134a95e9" name="aa863a7d5f36a89c6765ea0118bb9a1dcaa327176a0a845c117bdfadec134a95e9"></a>LESS_THAN&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aa863a7d5f36a89c6765ea0118bb9a1dca93d39e6064b3c462e437e20cd8b2bdab" name="aa863a7d5f36a89c6765ea0118bb9a1dca93d39e6064b3c462e437e20cd8b2bdab"></a>LESS_OR_EQUAL&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aa863a7d5f36a89c6765ea0118bb9a1dcac86ee0d9d7ed3e7b4fdbf486fa6c0ebb" name="aa863a7d5f36a89c6765ea0118bb9a1dcac86ee0d9d7ed3e7b4fdbf486fa6c0ebb"></a>IN&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aa863a7d5f36a89c6765ea0118bb9a1dcaf43267050fc487181424367e8496f2f9" name="aa863a7d5f36a89c6765ea0118bb9a1dcaf43267050fc487181424367e8496f2f9"></a>NOT_IN&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aa863a7d5f36a89c6765ea0118bb9a1dca558ffc8f5770d8e4f95f51d822685532" name="aa863a7d5f36a89c6765ea0118bb9a1dca558ffc8f5770d8e4f95f51d822685532"></a>AND&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aa863a7d5f36a89c6765ea0118bb9a1dca1d00e7dce692e8dc3f6877f035e3a616" name="aa863a7d5f36a89c6765ea0118bb9a1dca1d00e7dce692e8dc3f6877f035e3a616"></a>OR&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aa863a7d5f36a89c6765ea0118bb9a1dca1a1fe0fcacfcb22095aee25fa9c20ec1" name="aa863a7d5f36a89c6765ea0118bb9a1dca1a1fe0fcacfcb22095aee25fa9c20ec1"></a>STARTS_WITH&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aa863a7d5f36a89c6765ea0118bb9a1dca6db8b119b8d5008ca2f87d883bfff185" name="aa863a7d5f36a89c6765ea0118bb9a1dca6db8b119b8d5008ca2f87d883bfff185"></a>ENDS_WITH&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aa863a7d5f36a89c6765ea0118bb9a1dca7c8b81e077a45b6d2c9c03d3a22c0d5b" name="aa863a7d5f36a89c6765ea0118bb9a1dca7c8b81e077a45b6d2c9c03d3a22c0d5b"></a>CONTAINS&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aa863a7d5f36a89c6765ea0118bb9a1dcaa7598964efa10e649f92662b79e8d4d3" name="aa863a7d5f36a89c6765ea0118bb9a1dcaa7598964efa10e649f92662b79e8d4d3"></a>LIKE&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a56c7c5f77f752fe739c9560bac08ed22" name="a56c7c5f77f752fe739c9560bac08ed22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56c7c5f77f752fe739c9560bac08ed22">&#9670;&#160;</a></span>~Function()</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="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">virtual</a> paimon::Function::~Function </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a21935cc8cd44b2734f8ab6fb8e8143db" name="a21935cc8cd44b2734f8ab6fb8e8143db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21935cc8cd44b2734f8ab6fb8e8143db">&#9670;&#160;</a></span>GetType()</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="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">virtual</a> <a class="el" href="classpaimon_1_1_function.html#aa863a7d5f36a89c6765ea0118bb9a1dc">Type</a> paimon::Function::GetType </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">
</div>
</div>
<a id="aa7cd256e7c828b608245e3e9a7e8c3e8" name="aa7cd256e7c828b608245e3e9a7e8c3e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7cd256e7c828b608245e3e9a7e8c3e8">&#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"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">virtual</a> std::string paimon::Function::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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/predicate/<a class="el" href="function_8h_source.html">function.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>