path: root/tuple_8h.html

<!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>Relational Algebra Engine: include/tuple.h File 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">Relational Algebra Engine
   </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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">tuple.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="attribute_8h_source.html">attribute.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="set_8h_source.html">set.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for tuple.h:</div>
<div class="dyncontent">
<div class="center"><img src="tuple_8h__incl.png" border="0" usemap="#ainclude_2tuple_8h" alt=""/></div>
<map name="ainclude_2tuple_8h" id="ainclude_2tuple_8h">
<area shape="rect" title=" " alt="" coords="39,5,158,31"/>
<area shape="rect" href="attribute_8h.html" title=" " alt="" coords="5,79,96,104"/>
<area shape="poly" title=" " alt="" coords="93,33,68,69,64,66,89,30"/>
<area shape="rect" href="set_8h.html" title=" " alt="" coords="121,79,175,104"/>
<area shape="poly" title=" " alt="" coords="109,29,134,66,130,69,105,33"/>
<area shape="rect" title=" " alt="" coords="61,152,136,177"/>
<area shape="poly" title=" " alt="" coords="61,103,86,139,81,142,56,106"/>
<area shape="poly" title=" " alt="" coords="142,106,117,142,112,139,138,103"/>
</map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="tuple_8h__dep__incl.png" border="0" usemap="#ainclude_2tuple_8hdep" alt=""/></div>
<map name="ainclude_2tuple_8hdep" id="ainclude_2tuple_8hdep">
<area shape="rect" title=" " alt="" coords="96,5,215,31"/>
<area shape="rect" href="relation_8h.html" title=" " alt="" coords="88,79,223,104"/>
<area shape="poly" title=" " alt="" coords="158,44,158,79,153,79,153,44"/>
<area shape="rect" href="main_8c.html" title="Example usage and entry point for the Relational Algebra Engine." alt="" coords="5,152,95,177"/>
<area shape="poly" title=" " alt="" coords="123,40,98,58,78,80,61,118,54,152,48,151,55,117,73,77,95,54,120,36"/>
<area shape="rect" href="tuple_8c.html" title="Tuple implementation for the Relational Algebra Engine." alt="" coords="247,79,336,104"/>
<area shape="poly" title=" " alt="" coords="190,34,270,76,268,81,188,39"/>
<area shape="poly" title=" " alt="" coords="128,114,69,154,66,150,125,110"/>
<area shape="rect" href="relation_8c.html" title="Relation implementation for the Relational Algebra Engine." alt="" coords="119,152,226,177"/>
<area shape="poly" title=" " alt="" coords="164,117,172,151,167,153,159,118"/>
</map>
</div>
</div>
<p><a href="tuple_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a1dc581c6ec65e7a8712da56fb3a6d2ef" id="r_a1dc581c6ec65e7a8712da56fb3a6d2ef"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="structSet.html">Set</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="tuple_8h.html#a1dc581c6ec65e7a8712da56fb3a6d2ef">Tuple</a></td></tr>
<tr class="separator:a1dc581c6ec65e7a8712da56fb3a6d2ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a639960fa1a575569355816fadd7437ee" id="r_a639960fa1a575569355816fadd7437ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="tuple_8h.html#a1dc581c6ec65e7a8712da56fb3a6d2ef">Tuple</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="tuple_8h.html#a639960fa1a575569355816fadd7437ee">tuple_create</a> (void)</td></tr>
<tr class="memdesc:a639960fa1a575569355816fadd7437ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new Tuple.  <br /></td></tr>
<tr class="separator:a639960fa1a575569355816fadd7437ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeefa14da7fb7b4b40b8da4e1b536323e" id="r_aeefa14da7fb7b4b40b8da4e1b536323e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="tuple_8h.html#aeefa14da7fb7b4b40b8da4e1b536323e">tuple_destroy</a> (<a class="el" href="tuple_8h.html#a1dc581c6ec65e7a8712da56fb3a6d2ef">Tuple</a> *t)</td></tr>
<tr class="memdesc:aeefa14da7fb7b4b40b8da4e1b536323e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy a Tuple and free its memory.  <br /></td></tr>
<tr class="separator:aeefa14da7fb7b4b40b8da4e1b536323e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63de66548cc83afcefc268f4019d2daf" id="r_a63de66548cc83afcefc268f4019d2daf"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="tuple_8h.html#a63de66548cc83afcefc268f4019d2daf">tuple_add_attribute</a> (<a class="el" href="tuple_8h.html#a1dc581c6ec65e7a8712da56fb3a6d2ef">Tuple</a> *t, <a class="el" href="structAttribute.html">Attribute</a> *attr)</td></tr>
<tr class="memdesc:a63de66548cc83afcefc268f4019d2daf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add an <a class="el" href="structAttribute.html">Attribute</a> to a Tuple.  <br /></td></tr>
<tr class="separator:a63de66548cc83afcefc268f4019d2daf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41061ae6a531d605c2bb4ea089edc674" id="r_a41061ae6a531d605c2bb4ea089edc674"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="tuple_8h.html#a41061ae6a531d605c2bb4ea089edc674">tuple_print</a> (const <a class="el" href="tuple_8h.html#a1dc581c6ec65e7a8712da56fb3a6d2ef">Tuple</a> *t)</td></tr>
<tr class="memdesc:a41061ae6a531d605c2bb4ea089edc674"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print a Tuple to stdout.  <br /></td></tr>
<tr class="separator:a41061ae6a531d605c2bb4ea089edc674"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe09a57dbc3e53a9c75e7dfcd105e20a" id="r_abe09a57dbc3e53a9c75e7dfcd105e20a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structAttribute.html">Attribute</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="tuple_8h.html#abe09a57dbc3e53a9c75e7dfcd105e20a">tuple_find_attribute</a> (<a class="el" href="tuple_8h.html#a1dc581c6ec65e7a8712da56fb3a6d2ef">Tuple</a> *t, const char *name)</td></tr>
<tr class="memdesc:abe09a57dbc3e53a9c75e7dfcd105e20a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find an <a class="el" href="structAttribute.html">Attribute</a> in a Tuple by name.  <br /></td></tr>
<tr class="separator:abe09a57dbc3e53a9c75e7dfcd105e20a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a910c6d60f4130fc156f2c7d11c187be9" id="r_a910c6d60f4130fc156f2c7d11c187be9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="tuple_8h.html#a910c6d60f4130fc156f2c7d11c187be9">tuple_equals</a> (<a class="el" href="tuple_8h.html#a1dc581c6ec65e7a8712da56fb3a6d2ef">Tuple</a> *a, <a class="el" href="tuple_8h.html#a1dc581c6ec65e7a8712da56fb3a6d2ef">Tuple</a> *b)</td></tr>
<tr class="memdesc:a910c6d60f4130fc156f2c7d11c187be9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if two Tuples are equal (all attributes match).  <br /></td></tr>
<tr class="separator:a910c6d60f4130fc156f2c7d11c187be9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a1dc581c6ec65e7a8712da56fb3a6d2ef" name="a1dc581c6ec65e7a8712da56fb3a6d2ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1dc581c6ec65e7a8712da56fb3a6d2ef">&#9670;&#160;</a></span>Tuple</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="structSet.html">Set</a> <a class="el" href="tuple_8h.html#a1dc581c6ec65e7a8712da56fb3a6d2ef">Tuple</a></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a63de66548cc83afcefc268f4019d2daf" name="a63de66548cc83afcefc268f4019d2daf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63de66548cc83afcefc268f4019d2daf">&#9670;&#160;</a></span>tuple_add_attribute()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int tuple_add_attribute </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="tuple_8h.html#a1dc581c6ec65e7a8712da56fb3a6d2ef">Tuple</a> *&#160;</td>
          <td class="paramname"><em>t</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structAttribute.html">Attribute</a> *&#160;</td>
          <td class="paramname"><em>attr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Add an <a class="el" href="structAttribute.html">Attribute</a> to a Tuple. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">t</td><td>Pointer to the Tuple. </td></tr>
    <tr><td class="paramname">attr</td><td>Pointer to the <a class="el" href="structAttribute.html">Attribute</a> to add. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if added, 0 if already present, -1 on error. </dd></dl>

</div>
</div>
<a id="a639960fa1a575569355816fadd7437ee" name="a639960fa1a575569355816fadd7437ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a639960fa1a575569355816fadd7437ee">&#9670;&#160;</a></span>tuple_create()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="tuple_8h.html#a1dc581c6ec65e7a8712da56fb3a6d2ef">Tuple</a> * tuple_create </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Create a new Tuple. </p>
<dl class="section return"><dt>Returns</dt><dd>Pointer to new Tuple, or NULL on failure. </dd></dl>

</div>
</div>
<a id="aeefa14da7fb7b4b40b8da4e1b536323e" name="aeefa14da7fb7b4b40b8da4e1b536323e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeefa14da7fb7b4b40b8da4e1b536323e">&#9670;&#160;</a></span>tuple_destroy()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void tuple_destroy </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="tuple_8h.html#a1dc581c6ec65e7a8712da56fb3a6d2ef">Tuple</a> *&#160;</td>
          <td class="paramname"><em>t</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Destroy a Tuple and free its memory. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">t</td><td>Pointer to the Tuple to destroy. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a910c6d60f4130fc156f2c7d11c187be9" name="a910c6d60f4130fc156f2c7d11c187be9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a910c6d60f4130fc156f2c7d11c187be9">&#9670;&#160;</a></span>tuple_equals()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int tuple_equals </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="tuple_8h.html#a1dc581c6ec65e7a8712da56fb3a6d2ef">Tuple</a> *&#160;</td>
          <td class="paramname"><em>a</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="tuple_8h.html#a1dc581c6ec65e7a8712da56fb3a6d2ef">Tuple</a> *&#160;</td>
          <td class="paramname"><em>b</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Check if two Tuples are equal (all attributes match). </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">a</td><td>Pointer to first Tuple. </td></tr>
    <tr><td class="paramname">b</td><td>Pointer to second Tuple. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if equal, 0 otherwise. </dd></dl>

</div>
</div>
<a id="abe09a57dbc3e53a9c75e7dfcd105e20a" name="abe09a57dbc3e53a9c75e7dfcd105e20a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe09a57dbc3e53a9c75e7dfcd105e20a">&#9670;&#160;</a></span>tuple_find_attribute()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structAttribute.html">Attribute</a> * tuple_find_attribute </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="tuple_8h.html#a1dc581c6ec65e7a8712da56fb3a6d2ef">Tuple</a> *&#160;</td>
          <td class="paramname"><em>t</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>name</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Find an <a class="el" href="structAttribute.html">Attribute</a> in a Tuple by name. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">t</td><td>Pointer to the Tuple. </td></tr>
    <tr><td class="paramname">name</td><td>Name of the <a class="el" href="structAttribute.html">Attribute</a> to find. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to the found <a class="el" href="structAttribute.html">Attribute</a>, or NULL if not found. </dd></dl>

</div>
</div>
<a id="a41061ae6a531d605c2bb4ea089edc674" name="a41061ae6a531d605c2bb4ea089edc674"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41061ae6a531d605c2bb4ea089edc674">&#9670;&#160;</a></span>tuple_print()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void tuple_print </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="tuple_8h.html#a1dc581c6ec65e7a8712da56fb3a6d2ef">Tuple</a> *&#160;</td>
          <td class="paramname"><em>t</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Print a Tuple to stdout. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">t</td><td>Pointer to the Tuple to print. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</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>