path: root/relation_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/relation.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="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">relation.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="set_8h_source.html">set.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="tuple_8h_source.html">tuple.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for relation.h:</div>
<div class="dyncontent">
<div class="center"><img src="relation_8h__incl.png" border="0" usemap="#ainclude_2relation_8h" alt=""/></div>
<map name="ainclude_2relation_8h" id="ainclude_2relation_8h">
<area shape="rect" title=" " alt="" coords="5,5,140,31"/>
<area shape="rect" href="set_8h.html" title=" " alt="" coords="11,152,65,177"/>
<area shape="poly" title=" " alt="" coords="72,32,47,139,41,138,67,30"/>
<area shape="rect" href="tuple_8h.html" title=" " alt="" coords="75,79,142,104"/>
<area shape="poly" title=" " alt="" coords="81,30,99,65,94,68,76,32"/>
<area shape="rect" title=" " alt="" coords="49,225,123,251"/>
<area shape="poly" title=" " alt="" coords="48,176,73,213,68,216,44,179"/>
<area shape="poly" title=" " alt="" coords="99,106,61,144,57,140,95,102"/>
<area shape="rect" href="attribute_8h.html" title=" " alt="" coords="90,152,181,177"/>
<area shape="poly" title=" " alt="" coords="116,103,129,138,124,140,111,105"/>
<area shape="poly" title=" " alt="" coords="129,179,104,216,100,213,125,176"/>
</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="relation_8h__dep__incl.png" border="0" usemap="#ainclude_2relation_8hdep" alt=""/></div>
<map name="ainclude_2relation_8hdep" id="ainclude_2relation_8hdep">
<area shape="rect" title=" " alt="" coords="44,5,179,31"/>
<area shape="rect" href="main_8c.html" title="Example usage and entry point for the Relational Algebra Engine." alt="" coords="5,79,95,104"/>
<area shape="poly" title=" " alt="" coords="94,43,62,80,58,77,90,40"/>
<area shape="rect" href="relation_8c.html" title="Relation implementation for the Relational Algebra Engine." alt="" coords="119,79,226,104"/>
<area shape="poly" title=" " alt="" coords="132,40,165,77,161,80,128,43"/>
</map>
</div>
</div>
<p><a href="relation_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="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRelation.html">Relation</a></td></tr>
<tr class="separator:"><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:a5ae6c335d05a38f5abf0810dd6fa2990" id="r_a5ae6c335d05a38f5abf0810dd6fa2990"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structRelation.html">Relation</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="relation_8h.html#a5ae6c335d05a38f5abf0810dd6fa2990">relation_create</a> (const char *name)</td></tr>
<tr class="memdesc:a5ae6c335d05a38f5abf0810dd6fa2990"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <a class="el" href="structRelation.html">Relation</a>.  <br /></td></tr>
<tr class="separator:a5ae6c335d05a38f5abf0810dd6fa2990"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a718a2758d8ded2bd459f4b49e6ba5247" id="r_a718a2758d8ded2bd459f4b49e6ba5247"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="relation_8h.html#a718a2758d8ded2bd459f4b49e6ba5247">relation_add_tuple</a> (<a class="el" href="structRelation.html">Relation</a> *r, <a class="el" href="tuple_8h.html#a1dc581c6ec65e7a8712da56fb3a6d2ef">Tuple</a> *t)</td></tr>
<tr class="memdesc:a718a2758d8ded2bd459f4b49e6ba5247"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a tuple to a relation.  <br /></td></tr>
<tr class="separator:a718a2758d8ded2bd459f4b49e6ba5247"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a567fe5c42e7a418c9b2d25f543d055ab" id="r_a567fe5c42e7a418c9b2d25f543d055ab"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="relation_8h.html#a567fe5c42e7a418c9b2d25f543d055ab">relation_destroy</a> (<a class="el" href="structRelation.html">Relation</a> *r)</td></tr>
<tr class="memdesc:a567fe5c42e7a418c9b2d25f543d055ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy a <a class="el" href="structRelation.html">Relation</a> and free its memory.  <br /></td></tr>
<tr class="separator:a567fe5c42e7a418c9b2d25f543d055ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7662cf41d30fcc49e9acf625ae389898" id="r_a7662cf41d30fcc49e9acf625ae389898"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="relation_8h.html#a7662cf41d30fcc49e9acf625ae389898">relation_print</a> (const <a class="el" href="structRelation.html">Relation</a> *r)</td></tr>
<tr class="memdesc:a7662cf41d30fcc49e9acf625ae389898"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print a <a class="el" href="structRelation.html">Relation</a> to stdout.  <br /></td></tr>
<tr class="separator:a7662cf41d30fcc49e9acf625ae389898"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a199adac14c45258decea3c585a1bdff2" id="r_a199adac14c45258decea3c585a1bdff2"><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="relation_8h.html#a199adac14c45258decea3c585a1bdff2">relation_find_tuple</a> (<a class="el" href="structRelation.html">Relation</a> *r, <a class="el" href="tuple_8h.html#a1dc581c6ec65e7a8712da56fb3a6d2ef">Tuple</a> *t)</td></tr>
<tr class="memdesc:a199adac14c45258decea3c585a1bdff2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find a tuple in a relation matching the target.  <br /></td></tr>
<tr class="separator:a199adac14c45258decea3c585a1bdff2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a718a2758d8ded2bd459f4b49e6ba5247" name="a718a2758d8ded2bd459f4b49e6ba5247"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a718a2758d8ded2bd459f4b49e6ba5247">&#9670;&#160;</a></span>relation_add_tuple()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int relation_add_tuple </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structRelation.html">Relation</a> *&#160;</td>
          <td class="paramname"><em>r</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>t</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Add a tuple to a relation. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">r</td><td>Pointer to the <a class="el" href="structRelation.html">Relation</a>. </td></tr>
    <tr><td class="paramname">t</td><td>Pointer to the Tuple 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="a5ae6c335d05a38f5abf0810dd6fa2990" name="a5ae6c335d05a38f5abf0810dd6fa2990"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ae6c335d05a38f5abf0810dd6fa2990">&#9670;&#160;</a></span>relation_create()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structRelation.html">Relation</a> * relation_create </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>name</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Create a new <a class="el" href="structRelation.html">Relation</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>Name of the relation (copied). </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to the new <a class="el" href="structRelation.html">Relation</a>, or NULL on failure. </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void relation_destroy </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structRelation.html">Relation</a> *&#160;</td>
          <td class="paramname"><em>r</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Destroy a <a class="el" href="structRelation.html">Relation</a> and free its memory. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">r</td><td>Pointer to the <a class="el" href="structRelation.html">Relation</a> to destroy. Safe to pass NULL. </td></tr>
  </table>
  </dd>
</dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="tuple_8h.html#a1dc581c6ec65e7a8712da56fb3a6d2ef">Tuple</a> * relation_find_tuple </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structRelation.html">Relation</a> *&#160;</td>
          <td class="paramname"><em>r</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>target</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Find a tuple in a relation matching the target. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">r</td><td>Pointer to the <a class="el" href="structRelation.html">Relation</a>. </td></tr>
    <tr><td class="paramname">target</td><td>Pointer to the Tuple to find. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to the found Tuple, or NULL if not found. </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void relation_print </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structRelation.html">Relation</a> *&#160;</td>
          <td class="paramname"><em>r</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Print a <a class="el" href="structRelation.html">Relation</a> to stdout. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">r</td><td>Pointer to the <a class="el" href="structRelation.html">Relation</a> 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>