| <!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::Predicate< T > Class Template 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&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&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_1Predicate.html">Predicate</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pro-methods">Protected Member Functions</a> | |
| <a href="#pro-attribs">Protected Attributes</a> | |
| <a href="classiceberg_1_1Predicate-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::Predicate< T > Class Template Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A predicate is a boolean expression that tests a term against some criteria. |
| <a href="classiceberg_1_1Predicate.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="predicate_8h_source.html">predicate.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for iceberg::Predicate< T >:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classiceberg_1_1Predicate.png" usemap="#iceberg::Predicate_3C_20T_20_3E_map" alt=""/> |
| <map id="iceberg::Predicate_3C_20T_20_3E_map" name="iceberg::Predicate_3C_20T_20_3E_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:a149508fc8ddf4cd5d4da0ae9f4c1c80f" id="r_a149508fc8ddf4cd5d4da0ae9f4c1c80f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classiceberg_1_1Expression.html#a433076bdc34ce0b6d359313c6c7b8a9c">Expression::Operation</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Predicate.html#a149508fc8ddf4cd5d4da0ae9f4c1c80f">op</a> () const override</td></tr> |
| <tr class="memdesc:a149508fc8ddf4cd5d4da0ae9f4c1c80f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the operation for an expression node. <br /></td></tr> |
| <tr class="separator:a149508fc8ddf4cd5d4da0ae9f4c1c80f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acee9f864ef011a76e45d98f0d9bf42af" id="r_acee9f864ef011a76e45d98f0d9bf42af"><td class="memItemLeft" align="right" valign="top"><a id="acee9f864ef011a76e45d98f0d9bf42af" name="acee9f864ef011a76e45d98f0d9bf42af"></a> |
| const std::shared_ptr< T > & </td><td class="memItemRight" valign="bottom"><b>term</b> () const</td></tr> |
| <tr class="memdesc:acee9f864ef011a76e45d98f0d9bf42af"><td class="mdescLeft"> </td><td class="mdescRight">Returns the term this predicate tests. <br /></td></tr> |
| <tr class="separator:acee9f864ef011a76e45d98f0d9bf42af"><td class="memSeparator" colspan="2"> </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="-"/> Public Member Functions inherited from <a class="el" href="classiceberg_1_1Expression.html">iceberg::Expression</a></td></tr> |
| <tr class="memitem:a7ce9433b8cc063b06ac6371d6d56815c inherit pub_methods_classiceberg_1_1Expression" id="r_a7ce9433b8cc063b06ac6371d6d56815c"><td class="memItemLeft" align="right" valign="top">virtual Result< std::shared_ptr< <a class="el" href="classiceberg_1_1Expression.html">Expression</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Expression.html#a7ce9433b8cc063b06ac6371d6d56815c">Negate</a> () const</td></tr> |
| <tr class="memdesc:a7ce9433b8cc063b06ac6371d6d56815c inherit pub_methods_classiceberg_1_1Expression"><td class="mdescLeft"> </td><td class="mdescRight">Returns the negation of this expression, equivalent to not(this). <br /></td></tr> |
| <tr class="separator:a7ce9433b8cc063b06ac6371d6d56815c inherit pub_methods_classiceberg_1_1Expression"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5f62190ba4e74757afb0fba05acb1e6a inherit pub_methods_classiceberg_1_1Expression" id="r_a5f62190ba4e74757afb0fba05acb1e6a"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Expression.html#a5f62190ba4e74757afb0fba05acb1e6a">Equals</a> (const <a class="el" href="classiceberg_1_1Expression.html">Expression</a> &other) const</td></tr> |
| <tr class="memdesc:a5f62190ba4e74757afb0fba05acb1e6a inherit pub_methods_classiceberg_1_1Expression"><td class="mdescLeft"> </td><td class="mdescRight">Returns whether this expression will accept the same values as another. <br /></td></tr> |
| <tr class="separator:a5f62190ba4e74757afb0fba05acb1e6a inherit pub_methods_classiceberg_1_1Expression"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2e9c204f698d069ebc0fefb9e5269ab6 inherit pub_methods_classiceberg_1_1Expression" id="r_a2e9c204f698d069ebc0fefb9e5269ab6"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Expression.html#a2e9c204f698d069ebc0fefb9e5269ab6">ToString</a> () const override</td></tr> |
| <tr class="memdesc:a2e9c204f698d069ebc0fefb9e5269ab6 inherit pub_methods_classiceberg_1_1Expression"><td class="mdescLeft"> </td><td class="mdescRight">Get a user-readable string representation. <br /></td></tr> |
| <tr class="separator:a2e9c204f698d069ebc0fefb9e5269ab6 inherit pub_methods_classiceberg_1_1Expression"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a96e614d02433117161d21989f7ff1257 inherit pub_methods_classiceberg_1_1Expression" id="r_a96e614d02433117161d21989f7ff1257"><td class="memItemLeft" align="right" valign="top"> |
| virtual bool </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"> </td></tr> |
| <tr class="memitem:a8807793506a834a71384dac034e6c62f inherit pub_methods_classiceberg_1_1Expression" id="r_a8807793506a834a71384dac034e6c62f"><td class="memItemLeft" align="right" valign="top"> |
| virtual bool </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"> </td></tr> |
| <tr class="memitem:a9d17c720a2f03ee4924b8c36f0420ff1 inherit pub_methods_classiceberg_1_1Expression" id="r_a9d17c720a2f03ee4924b8c36f0420ff1"><td class="memItemLeft" align="right" valign="top"> |
| virtual bool </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"> </td></tr> |
| <tr class="memitem:ab760f80ffc03ab40301be7d59c621a4a inherit pub_methods_classiceberg_1_1Expression" id="r_ab760f80ffc03ab40301be7d59c621a4a"><td class="memItemLeft" align="right" valign="top"> |
| virtual bool </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"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a> |
| Protected Member Functions</h2></td></tr> |
| <tr class="memitem:ae1f081b37983ae239d609238ed382f73" id="r_ae1f081b37983ae239d609238ed382f73"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Predicate.html#ae1f081b37983ae239d609238ed382f73">Predicate</a> (<a class="el" href="classiceberg_1_1Expression.html#a433076bdc34ce0b6d359313c6c7b8a9c">Expression::Operation</a> <a class="el" href="classiceberg_1_1Predicate.html#a149508fc8ddf4cd5d4da0ae9f4c1c80f">op</a>, std::shared_ptr< T > <a class="el" href="classiceberg_1_1Predicate.html#acee9f864ef011a76e45d98f0d9bf42af">term</a>)</td></tr> |
| <tr class="memdesc:ae1f081b37983ae239d609238ed382f73"><td class="mdescLeft"> </td><td class="mdescRight">Create a predicate with an operation and term. <br /></td></tr> |
| <tr class="separator:ae1f081b37983ae239d609238ed382f73"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a> |
| Protected Attributes</h2></td></tr> |
| <tr class="memitem:ae7cd54c4e3e6d62b81e5824d84d33381" id="r_ae7cd54c4e3e6d62b81e5824d84d33381"><td class="memItemLeft" align="right" valign="top"><a id="ae7cd54c4e3e6d62b81e5824d84d33381" name="ae7cd54c4e3e6d62b81e5824d84d33381"></a> |
| <a class="el" href="classiceberg_1_1Expression.html#a433076bdc34ce0b6d359313c6c7b8a9c">Expression::Operation</a> </td><td class="memItemRight" valign="bottom"><b>operation_</b></td></tr> |
| <tr class="separator:ae7cd54c4e3e6d62b81e5824d84d33381"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab1f8f6820bbbbd1d14ea847cd492aa4a" id="r_ab1f8f6820bbbbd1d14ea847cd492aa4a"><td class="memItemLeft" align="right" valign="top"><a id="ab1f8f6820bbbbd1d14ea847cd492aa4a" name="ab1f8f6820bbbbd1d14ea847cd492aa4a"></a> |
| std::shared_ptr< T > </td><td class="memItemRight" valign="bottom"><b>term_</b></td></tr> |
| <tr class="separator:ab1f8f6820bbbbd1d14ea847cd492aa4a"><td class="memSeparator" colspan="2"> </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="-"/> 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  </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Expression.html#a433076bdc34ce0b6d359313c6c7b8a9c">Operation</a> { <br /> |
|   <b>kTrue</b> |
| , <b>kFalse</b> |
| , <b>kIsNull</b> |
| , <b>kNotNull</b> |
| , <br /> |
|   <b>kIsNan</b> |
| , <b>kNotNan</b> |
| , <b>kLt</b> |
| , <b>kLtEq</b> |
| , <br /> |
|   <b>kGt</b> |
| , <b>kGtEq</b> |
| , <b>kEq</b> |
| , <b>kNotEq</b> |
| , <br /> |
|   <b>kIn</b> |
| , <b>kNotIn</b> |
| , <b>kNot</b> |
| , <b>kAnd</b> |
| , <br /> |
|   <b>kOr</b> |
| , <b>kStartsWith</b> |
| , <b>kNotStartsWith</b> |
| , <b>kCount</b> |
| , <br /> |
|   <b>kCountNull</b> |
| , <b>kCountStar</b> |
| , <b>kMax</b> |
| , <b>kMin</b> |
| <br /> |
| }</td></tr> |
| <tr class="memdesc:a433076bdc34ce0b6d359313c6c7b8a9c"><td class="mdescLeft"> </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"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><div class="compoundTemplParams">template<TermType T><br /> |
| class iceberg::Predicate< T ></div><p>A predicate is a boolean expression that tests a term against some criteria. </p> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">TermType</td><td>The type of the term being tested </td></tr> |
| </table> |
| </dd> |
| </dl> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="ae1f081b37983ae239d609238ed382f73" name="ae1f081b37983ae239d609238ed382f73"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae1f081b37983ae239d609238ed382f73">◆ </a></span>Predicate()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<TermType T> </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classiceberg_1_1Predicate.html">iceberg::Predicate</a>< T >::Predicate </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classiceberg_1_1Expression.html#a433076bdc34ce0b6d359313c6c7b8a9c">Expression::Operation</a> </td> |
| <td class="paramname"><em>op</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::shared_ptr< T > </td> |
| <td class="paramname"><em>term</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create a predicate with an operation and term. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">op</td><td>The operation this predicate performs </td></tr> |
| <tr><td class="paramname">term</td><td>The term this predicate tests </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a149508fc8ddf4cd5d4da0ae9f4c1c80f" name="a149508fc8ddf4cd5d4da0ae9f4c1c80f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a149508fc8ddf4cd5d4da0ae9f4c1c80f">◆ </a></span>op()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<TermType T> </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classiceberg_1_1Expression.html#a433076bdc34ce0b6d359313c6c7b8a9c">Expression::Operation</a> <a class="el" href="classiceberg_1_1Predicate.html">iceberg::Predicate</a>< T >::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> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>iceberg/expression/<a class="el" href="predicate_8h_source.html">predicate.h</a></li> |
| <li>iceberg/expression/<b>predicate.cc</b></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <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> |
