Documentation for 2c68b68ca6

This commit is contained in:
github-actions
2023-07-25 01:00:26 +00:00
parent e9138e9e94
commit dc4d3f2965
66 changed files with 736 additions and 646 deletions

View File

@@ -1,258 +0,0 @@
<!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.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Algorithms_in_C++: greedy_algorithms::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>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML/MathJax.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">Algorithms_in_C++<span id="projectnumber">&#160;1.0.0</span>
</div>
<div id="projectbrief">Set of algorithms implemented in C++.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<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>
</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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('d3/d64/classgreedy__algorithms_1_1_graph.html','../../'); initResizable(); });
/* @license-end */
</script>
<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="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="../../d4/d6d/classgreedy__algorithms_1_1_graph-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">greedy_algorithms::Graph Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Wrapper class for storing a graph.
<a href="../../d3/d64/classgreedy__algorithms_1_1_graph.html#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for greedy_algorithms::Graph:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../da/d74/classgreedy__algorithms_1_1_graph__coll__graph.svg" width="168" height="155"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<center><span class="legend">[<a target="top" href="../../graph_legend.html">legend</a>]</span></center></div>
<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:ac0f2ff5759957b72ba5bbad592aa2381"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d64/classgreedy__algorithms_1_1_graph.html#ac0f2ff5759957b72ba5bbad592aa2381">Graph</a> (const int V)</td></tr>
<tr class="memdesc:ac0f2ff5759957b72ba5bbad592aa2381"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a graph. <br /></td></tr>
<tr class="separator:ac0f2ff5759957b72ba5bbad592aa2381"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0672b080707aaaacf9cc116d69ea4c3f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d64/classgreedy__algorithms_1_1_graph.html#a0672b080707aaaacf9cc116d69ea4c3f">add_edge</a> (int src, int dst, int weight)</td></tr>
<tr class="memdesc:a0672b080707aaaacf9cc116d69ea4c3f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds an edge to the graph. <br /></td></tr>
<tr class="separator:a0672b080707aaaacf9cc116d69ea4c3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:abec975bd88bd3349144bdbc545c1d608"><td class="memItemLeft" align="right" valign="top"><a id="abec975bd88bd3349144bdbc545c1d608" name="abec975bd88bd3349144bdbc545c1d608"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>vertexNum</b> = 0</td></tr>
<tr class="separator:abec975bd88bd3349144bdbc545c1d608"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4eab698b7e9f203f9d2153d58f2ff2c4"><td class="memItemLeft" align="right" valign="top"><a id="a4eab698b7e9f203f9d2153d58f2ff2c4" name="a4eab698b7e9f203f9d2153d58f2ff2c4"></a>
<a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; int &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>edges</b> {}</td></tr>
<tr class="separator:a4eab698b7e9f203f9d2153d58f2ff2c4"><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>Wrapper class for storing a graph. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ac0f2ff5759957b72ba5bbad592aa2381" name="ac0f2ff5759957b72ba5bbad592aa2381"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac0f2ff5759957b72ba5bbad592aa2381">&#9670;&#160;</a></span>Graph()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">greedy_algorithms::Graph::Graph </td>
<td>(</td>
<td class="paramtype">const int&#160;</td>
<td class="paramname"><em>V</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a graph. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">V</td><td>number of vertices of the graph </td></tr>
</table>
</dd>
</dl>
<div class="fragment"><div class="line"><span class="lineno"> 42</span> {</div>
<div class="line"><span class="lineno"> 43</span> <span class="comment">// Initialize the array edges</span></div>
<div class="line"><span class="lineno"> 44</span> this-&gt;edges = <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;std::vector&lt;int&gt;</a>&gt;(V, <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;int&gt;</a>(V, 0));</div>
<div class="line"><span class="lineno"> 45</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; V; i++) {</div>
<div class="line"><span class="lineno"> 46</span> edges[i] = <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;int&gt;</a>(V, 0);</div>
<div class="line"><span class="lineno"> 47</span> }</div>
<div class="line"><span class="lineno"> 48</span> </div>
<div class="line"><span class="lineno"> 49</span> <span class="comment">// Fills the array with zeros</span></div>
<div class="line"><span class="lineno"> 50</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; V; i++) {</div>
<div class="line"><span class="lineno"> 51</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> j = 0; j &lt; V; j++) {</div>
<div class="line"><span class="lineno"> 52</span> edges[i][j] = 0;</div>
<div class="line"><span class="lineno"> 53</span> }</div>
<div class="line"><span class="lineno"> 54</span> }</div>
<div class="line"><span class="lineno"> 55</span> </div>
<div class="line"><span class="lineno"> 56</span> this-&gt;vertexNum = V;</div>
<div class="line"><span class="lineno"> 57</span> }</div>
<div class="ttc" id="avector_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a></div></div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a0672b080707aaaacf9cc116d69ea4c3f" name="a0672b080707aaaacf9cc116d69ea4c3f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0672b080707aaaacf9cc116d69ea4c3f">&#9670;&#160;</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 greedy_algorithms::Graph::add_edge </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>weight</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds an edge to the graph. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">src</td><td>the graph the edge should be added to </td></tr>
<tr><td class="paramname">dst</td><td>the position where the edge should be added to </td></tr>
<tr><td class="paramname">weight</td><td>the weight of the edge that should be added </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
<div class="fragment"><div class="line"><span class="lineno"> 66</span> {</div>
<div class="line"><span class="lineno"> 67</span> this-&gt;edges[src][dst] = weight;</div>
<div class="line"><span class="lineno"> 68</span> }</div>
</div><!-- fragment -->
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>greedy_algorithms/<a class="el" href="../../df/dcb/greedy__algorithms_2dijkstra_8cpp.html">dijkstra.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="../../d2/d90/namespacegreedy__algorithms.html">greedy_algorithms</a></li><li class="navelem"><a class="el" href="../../d3/d64/classgreedy__algorithms_1_1_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.9.7 </li>
</ul>
</div>
</body>
</html>

View File

@@ -1,5 +0,0 @@
var classgreedy__algorithms_1_1_graph =
[
[ "Graph", "d3/d64/classgreedy__algorithms_1_1_graph.html#ac0f2ff5759957b72ba5bbad592aa2381", null ],
[ "add_edge", "d3/d64/classgreedy__algorithms_1_1_graph.html#a0672b080707aaaacf9cc116d69ea4c3f", null ]
];