deploy: 5ed1406c81044ff73fd919b5aad184aaed0a174bgh-pages

1 files changed, 304 insertions, 0 deletions

diff --git a/relation_8c.html b/relation_8c.html
new file mode 100644
index 0000000..60fa6e3
--- /dev/null
+++ b/relation_8c.html
@@ -0,0 +1,304 @@
+<!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: src/relation.c 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_68267d1309a1af8e8297ef4c3efbcdba.html">src</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.c File Reference</div></div>
+</div><!--header-->
+<div class="contents">
+
+<p><a class="el" href="structRelation.html">Relation</a> implementation for the Relational Algebra Engine.  
+<a href="#details">More...</a></p>
+<div class="textblock"><code>#include &lt;stdio.h&gt;</code><br />
+<code>#include &lt;stdlib.h&gt;</code><br />
+<code>#include &lt;string.h&gt;</code><br />
+<code>#include &quot;<a class="el" href="relation_8h_source.html">relation.h</a>&quot;</code><br />
+</div><div class="textblock"><div class="dynheader">
+Include dependency graph for relation.c:</div>
+<div class="dyncontent">
+<div class="center"><img src="relation_8c__incl.png" border="0" usemap="#asrc_2relation_8c" alt=""/></div>
+<map name="asrc_2relation_8c" id="asrc_2relation_8c">
+<area shape="rect" title="Relation implementation for the Relational Algebra Engine." alt="" coords="125,5,232,31"/>
+<area shape="rect" title=" " alt="" coords="5,79,72,104"/>
+<area shape="poly" title=" " alt="" coords="157,33,75,75,72,70,155,28"/>
+<area shape="rect" title=" " alt="" coords="97,79,167,104"/>
+<area shape="poly" title=" " alt="" coords="173,32,149,69,145,66,169,30"/>
+<area shape="rect" title=" " alt="" coords="191,79,262,104"/>
+<area shape="poly" title=" " alt="" coords="189,30,214,66,209,69,184,33"/>
+<area shape="rect" href="relation_8h.html" title=" " alt="" coords="286,79,370,104"/>
+<area shape="poly" title=" " alt="" coords="204,28,292,70,290,75,202,33"/>
+<area shape="rect" href="set_8h.html" title=" " alt="" coords="265,225,319,251"/>
+<area shape="poly" title=" " alt="" coords="328,105,301,213,296,211,322,104"/>
+<area shape="rect" href="tuple_8h.html" title=" " alt="" coords="329,152,396,177"/>
+<area shape="poly" title=" " alt="" coords="336,103,353,138,349,141,331,106"/>
+<area shape="rect" title=" " alt="" coords="303,299,377,324"/>
+<area shape="poly" title=" " alt="" coords="302,250,327,286,322,289,298,253"/>
+<area shape="poly" title=" " alt="" coords="353,180,315,218,311,214,349,176"/>
+<area shape="rect" href="attribute_8h.html" title=" " alt="" coords="344,225,435,251"/>
+<area shape="poly" title=" " alt="" coords="370,177,383,212,378,214,365,179"/>
+<area shape="poly" title=" " alt="" coords="383,253,358,289,354,286,379,249"/>
+</map>
+</div>
+</div><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="structFindTupleContext.html">FindTupleContext</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_8c.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:a567fe5c42e7a418c9b2d25f543d055ab" id="r_a567fe5c42e7a418c9b2d25f543d055ab"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="relation_8c.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:a718a2758d8ded2bd459f4b49e6ba5247" id="r_a718a2758d8ded2bd459f4b49e6ba5247"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="relation_8c.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:a7662cf41d30fcc49e9acf625ae389898" id="r_a7662cf41d30fcc49e9acf625ae389898"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="relation_8c.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:a4d2b75c6c804dc9df58c95f167b17cfe" id="r_a4d2b75c6c804dc9df58c95f167b17cfe"><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_8c.html#a4d2b75c6c804dc9df58c95f167b17cfe">relation_find_tuple</a> (<a class="el" href="structRelation.html">Relation</a> *r, <a class="el" href="tuple_8h.html#a1dc581c6ec65e7a8712da56fb3a6d2ef">Tuple</a> *target)</td></tr>
+<tr class="memdesc:a4d2b75c6c804dc9df58c95f167b17cfe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find a tuple in a relation matching the target.  <br /></td></tr>
+<tr class="separator:a4d2b75c6c804dc9df58c95f167b17cfe"><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 class="el" href="structRelation.html">Relation</a> implementation for the Relational Algebra Engine. </p>
+<p>Provides creation, destruction, and manipulation of relations (for now, simply sets of tuples), adhering to the strict theoretical model of relational algebra. </p>
+</div><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="a4d2b75c6c804dc9df58c95f167b17cfe" name="a4d2b75c6c804dc9df58c95f167b17cfe"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a4d2b75c6c804dc9df58c95f167b17cfe">&#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>