blob: a96ecf8993e24b4b997b83d4330c1160affd69d8 [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::Term 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_1Term.html">Term</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="classiceberg_1_1Term-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::Term Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>A term is an expression node that produces a typed value when evaluated.
<a href="classiceberg_1_1Term.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::Term:</div>
<div class="dyncontent">
<div class="center">
<img src="classiceberg_1_1Term.png" usemap="#iceberg::Term_map" alt=""/>
<map id="iceberg::Term_map" name="iceberg::Term_map">
<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="525,0,815,24"/>
<area href="classiceberg_1_1UnboundTerm.html" alt="iceberg::UnboundTerm&lt; BoundReference &gt;" shape="rect" coords="0,112,290,136"/>
<area href="classiceberg_1_1UnboundTerm.html" alt="iceberg::UnboundTerm&lt; class BoundTransform &gt;" shape="rect" coords="300,112,590,136"/>
<area href="classiceberg_1_1BoundTerm.html" title="Base class for bound terms." alt="iceberg::BoundTerm" shape="rect" coords="750,112,1040,136"/>
<area href="classiceberg_1_1UnboundTerm.html" title="Base class for unbound terms." alt="iceberg::UnboundTerm&lt; B &gt;" shape="rect" coords="1050,112,1340,136"/>
<area href="classiceberg_1_1NamedReference.html" title="A reference to an unbound named field." alt="iceberg::NamedReference" shape="rect" coords="0,168,290,192"/>
<area href="classiceberg_1_1UnboundTransform.html" title="An unbound transform expression." alt="iceberg::UnboundTransform" shape="rect" coords="300,168,590,192"/>
<area href="classiceberg_1_1BoundReference.html" title="A reference to a bound field." alt="iceberg::BoundReference" shape="rect" coords="600,168,890,192"/>
<area href="classiceberg_1_1BoundTransform.html" title="A bound transform expression." alt="iceberg::BoundTransform" shape="rect" coords="900,168,1190,192"/>
</map>
</div></div>
<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:aafdab7cb8b14117f662d394450af6be8" 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"><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:abc8368a414f930269b883a090869eb14" 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"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the kind of this term. <br /></td></tr>
<tr class="separator:abc8368a414f930269b883a090869eb14"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14267bbe97519bec67cec9c4ca569090" id="r_a14267bbe97519bec67cec9c4ca569090"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Term.html#a14267bbe97519bec67cec9c4ca569090">is_unbound</a> () const =0</td></tr>
<tr class="memdesc:a14267bbe97519bec67cec9c4ca569090"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether this term is unbound. <br /></td></tr>
<tr class="separator:a14267bbe97519bec67cec9c4ca569090"><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>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A term is an expression node that produces a typed value when evaluated. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a14267bbe97519bec67cec9c4ca569090" name="a14267bbe97519bec67cec9c4ca569090"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14267bbe97519bec67cec9c4ca569090">&#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">virtual bool iceberg::Term::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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns whether this term is unbound. </p>
<p>Implemented in <a class="el" href="classiceberg_1_1UnboundTerm.html#a7c94829ddcc3940ea31b8dd8b5008fdc">iceberg::UnboundTerm&lt; B &gt;</a>, <a class="el" href="classiceberg_1_1UnboundTerm.html#a7c94829ddcc3940ea31b8dd8b5008fdc">iceberg::UnboundTerm&lt; BoundReference &gt;</a>, <a class="el" href="classiceberg_1_1UnboundTerm.html#a7c94829ddcc3940ea31b8dd8b5008fdc">iceberg::UnboundTerm&lt; class BoundTransform &gt;</a>, and <a class="el" href="classiceberg_1_1BoundTerm.html#a74959f3a65f7a8fcf9f11e0b23f05e58">iceberg::BoundTerm</a>.</p>
</div>
</div>
<a id="abc8368a414f930269b883a090869eb14" name="abc8368a414f930269b883a090869eb14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc8368a414f930269b883a090869eb14">&#9670;&#160;</a></span>kind()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual Kind iceberg::Term::kind </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 kind of this term. </p>
<p>Implemented in <a class="el" href="classiceberg_1_1NamedReference.html#af5ddc401012195f12349f37a7facdcc7">iceberg::NamedReference</a>, <a class="el" href="classiceberg_1_1BoundReference.html#a7c7d89b6d28ffeb8f5e8bb08c104c65f">iceberg::BoundReference</a>, <a class="el" href="classiceberg_1_1UnboundTransform.html#a3f0a01c4063aa0b1bd544855de4f2350">iceberg::UnboundTransform</a>, and <a class="el" href="classiceberg_1_1BoundTransform.html#a292aa1addf1dcdf01595ee24418c1445">iceberg::BoundTransform</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>iceberg/expression/<a class="el" href="term_8h_source.html">term.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>