283 lines
12 KiB
HTML
283 lines
12 KiB
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.16.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Graph Theory: Graph 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>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="cookie.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">Graph Theory
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.16.1 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
</script>
|
|
<script type="text/javascript">
|
|
$(function() { codefold.init(); });
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',true);
|
|
$(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(function(){initNavTree('class_graph.html','','class_graph-members'); });
|
|
</script>
|
|
<div id="container">
|
|
<div id="doc-content">
|
|
<!-- 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 class="header">
|
|
<div class="headertitle"><div class="title">Graph Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a230f67d1097f0a88f1cded9be1040ce9" id="r_a230f67d1097f0a88f1cded9be1040ce9"><td class="memItemLeft"> </td><td class="memItemRight"><a class="el" href="#a230f67d1097f0a88f1cded9be1040ce9">Graph</a> (size_t maxPoints, size_t maxEdges) noexcept</td></tr>
|
|
<tr class="memitem:a902c5b3eacb66d60752525ab23297a95" id="r_a902c5b3eacb66d60752525ab23297a95"><td class="memItemLeft"> </td><td class="memItemRight"><a class="el" href="#a902c5b3eacb66d60752525ab23297a95">~Graph</a> ()</td></tr>
|
|
<tr class="memitem:a61af63f3d00e297e91772b482de3dc74" id="r_a61af63f3d00e297e91772b482de3dc74"><td class="memItemLeft"> </td><td class="memItemRight"><a class="el" href="#a61af63f3d00e297e91772b482de3dc74">Graph</a> (<a class="el" href="class_graph.html">Graph</a> &&other) noexcept</td></tr>
|
|
<tr class="memitem:a81382d6a8dffca97d8e3c8e00faf7cf6" id="r_a81382d6a8dffca97d8e3c8e00faf7cf6"><td class="memItemLeft"><a class="el" href="struct_edge.html">Edge</a> * </td><td class="memItemRight"><a class="el" href="#a81382d6a8dffca97d8e3c8e00faf7cf6">get_p_edges</a> (int p_index) noexcept</td></tr>
|
|
<tr class="memitem:af96ec89a386c4b1f8e74619bc7b028cc" id="r_af96ec89a386c4b1f8e74619bc7b028cc"><td class="memItemLeft">void </td><td class="memItemRight"><a class="el" href="#af96ec89a386c4b1f8e74619bc7b028cc">add_edge</a> (int start_point_index, int end_point_index) noexcept</td></tr>
|
|
<tr class="memitem:a2f9dee7e816e54dfd01e1e3a6183dc56" id="r_a2f9dee7e816e54dfd01e1e3a6183dc56"><td class="memItemLeft"><a id="a2f9dee7e816e54dfd01e1e3a6183dc56" name="a2f9dee7e816e54dfd01e1e3a6183dc56"></a>
|
|
 </td><td class="memItemRight"><b>Graph</b> (const <a class="el" href="class_graph.html">Graph</a> &)=delete</td></tr>
|
|
<tr class="memitem:a05cae32d4ce8cf857a1c8d35a32024cd" id="r_a05cae32d4ce8cf857a1c8d35a32024cd"><td class="memItemLeft"><a id="a05cae32d4ce8cf857a1c8d35a32024cd" name="a05cae32d4ce8cf857a1c8d35a32024cd"></a>
|
|
<a class="el" href="class_graph.html">Graph</a> & </td><td class="memItemRight"><b>operator=</b> (const <a class="el" href="class_graph.html">Graph</a> &)=delete</td></tr>
|
|
</table>
|
|
<a name="doc-constructors" id="doc-constructors"></a><h2 id="header-doc-constructors" class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a230f67d1097f0a88f1cded9be1040ce9" name="a230f67d1097f0a88f1cded9be1040ce9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a230f67d1097f0a88f1cded9be1040ce9">◆ </a></span>Graph() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Graph::Graph </td>
|
|
<td>(</td>
|
|
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>max_points</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>max_edges</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Constructor Creates a new <a class="el" href="class_graph.html">Graph</a> object</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">max_points</td><td>: Maximum number of points in the <a class="el" href="class_graph.html">Graph</a> </td></tr>
|
|
<tr><td class="paramname">max_edges</td><td>: Maximum number of edges in the GRAPH (not the point) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a902c5b3eacb66d60752525ab23297a95" name="a902c5b3eacb66d60752525ab23297a95"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a902c5b3eacb66d60752525ab23297a95">◆ </a></span>~Graph()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Graph::~Graph </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Deconstruction NOTE on the '<a class="el" href="#a902c5b3eacb66d60752525ab23297a95">~Graph()</a>': The ~ flags this block as a deconstructor. It makes it so this runs before the object is removed from memory preventing memory leaks Find the memory buffers pointed to by all_points and all_edges, and mark that memory as available for other programs to use. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a61af63f3d00e297e91772b482de3dc74" name="a61af63f3d00e297e91772b482de3dc74"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a61af63f3d00e297e91772b482de3dc74">◆ </a></span>Graph() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Graph::Graph </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_graph.html">Graph</a> &&</td> <td class="paramname"><span class="paramname"><em>other</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Move Constructor Instructions to move the current graph object from one memory location to another without copying </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
|
|
<a id="af96ec89a386c4b1f8e74619bc7b028cc" name="af96ec89a386c4b1f8e74619bc7b028cc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af96ec89a386c4b1f8e74619bc7b028cc">◆ </a></span>add_edge()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Graph::add_edge </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>start_point_index</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>end_point_index</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>add_edge Adds an edge between two points</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">start_point_index</td><td>: the index of the starting point </td></tr>
|
|
<tr><td class="paramname">end_point_index</td><td>: the index of the ending point </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a81382d6a8dffca97d8e3c8e00faf7cf6" name="a81382d6a8dffca97d8e3c8e00faf7cf6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a81382d6a8dffca97d8e3c8e00faf7cf6">◆ </a></span>get_p_edges()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="struct_edge.html">Edge</a> * Graph::get_p_edges </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>p_index</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Getter Function: get_p_edges Gets the address of the first edge for <a class="el" href="struct_point.html">Point</a> P at index p_index</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">p_index</td><td>: The index (int) of the point </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Edge* : the address of the first edge for p_index </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="graph_8h_source.html">graph.h</a></li>
|
|
<li><b>Graph.cpp</b></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<div id="page-nav" class="page-nav-panel">
|
|
<div id="page-nav-resize-handle"></div>
|
|
<div id="page-nav-tree">
|
|
<div id="page-nav-contents">
|
|
</div><!-- page-nav-contents -->
|
|
</div><!-- page-nav-tree -->
|
|
</div><!-- page-nav -->
|
|
</div><!-- container -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a href="class_graph.html">Graph</a></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|