Skip to content

Commit

Permalink
Documentation Update (#31)
Browse files Browse the repository at this point in the history 
* Updated Doxygen Documentation

* [CodeFactor] Apply fixes to commit 11a9528

Co-authored-by: codefactor-io <[email protected]>
  • Loading branch information
@ZigRazor @code-factor
ZigRazor and code-factor authored Jul 16, 2021
1 parent d84be7c commit de86eda
Show file tree
Hide file tree
Showing 81 changed files with 2,450 additions and 1,651 deletions.
9 changes: 5 additions & 4 deletions docs/html/annotated.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">CXXGraph
&#160;<span id="projectnumber">0.1.2</span>
&#160;<span id="projectnumber">0.1.3</span>
</div>
<div id="projectbrief">CXXGraph is a small library, header only, that manages the Graph and it&#39;s algorithm in C++</div>
</td>
Expand Down Expand Up @@ -78,9 +78,10 @@
<tr id="row_0_4_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="da/d55/classCXXGRAPH_1_1DirectedWeightedEdge.html" target="_self">DirectedWeightedEdge</a></td><td class="desc"></td></tr>
<tr id="row_0_5_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d7/d24/classCXXGRAPH_1_1UndirectedWeightedEdge.html" target="_self">UndirectedWeightedEdge</a></td><td class="desc"></td></tr>
<tr id="row_0_6_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d0/df2/classCXXGRAPH_1_1Graph.html" target="_self">Graph</a></td><td class="desc"></td></tr>
<tr id="row_0_7_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="dd/d6c/structCXXGRAPH_1_1DijkstraResult__struct.html" target="_self">DijkstraResult_struct</a></td><td class="desc"></td></tr>
<tr id="row_0_8_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="db/d54/classCXXGRAPH_1_1Weighted.html" target="_self">Weighted</a></td><td class="desc"></td></tr>
<tr id="row_0_9_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d4/d32/classCXXGRAPH_1_1Partition.html" target="_self">Partition</a></td><td class="desc"></td></tr>
<tr id="row_0_7_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d4/d32/classCXXGRAPH_1_1Partition.html" target="_self">Partition</a></td><td class="desc"></td></tr>
<tr id="row_0_8_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="dd/d6c/structCXXGRAPH_1_1DijkstraResult__struct.html" target="_self">DijkstraResult_struct</a></td><td class="desc">Struct that contains the information about Dijsktra's Algorithm results </td></tr>
<tr id="row_0_9_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d2/def/structCXXGRAPH_1_1PartitioningStats__struct.html" target="_self">PartitioningStats_struct</a></td><td class="desc">Struct that contains the information about the partitioning statistics </td></tr>
<tr id="row_0_10_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="db/d54/classCXXGRAPH_1_1Weighted.html" target="_self">Weighted</a></td><td class="desc"></td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
Expand Down
4 changes: 2 additions & 2 deletions docs/html/classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">CXXGraph
&#160;<span id="projectnumber">0.1.2</span>
&#160;<span id="projectnumber">0.1.3</span>
</div>
<div id="projectbrief">CXXGraph is a small library, header only, that manages the Graph and it&#39;s algorithm in C++</div>
</td>
Expand Down Expand Up @@ -84,7 +84,7 @@
<dd><a class="el" href="d3/dd2/classCXXGRAPH_1_1Node.html">Node</a> (CXXGRAPH)</dd></dl>
<dl class="classindex even">
<dt class="alphachar"><a name="letter_P">P</a></dt>
<dd><a class="el" href="d4/d32/classCXXGRAPH_1_1Partition.html">Partition</a> (CXXGRAPH)</dd></dl>
<dd><a class="el" href="d4/d32/classCXXGRAPH_1_1Partition.html">Partition</a> (CXXGRAPH)</dd><dd><a class="el" href="d2/def/structCXXGRAPH_1_1PartitioningStats__struct.html">PartitioningStats_struct</a> (CXXGRAPH)</dd></dl>
<dl class="classindex odd">
<dt class="alphachar"><a name="letter_U">U</a></dt>
<dd><a class="el" href="df/d71/classCXXGRAPH_1_1UndirectedEdge.html">UndirectedEdge</a> (CXXGRAPH)</dd><dd><a class="el" href="d7/d24/classCXXGRAPH_1_1UndirectedWeightedEdge.html">UndirectedWeightedEdge</a> (CXXGRAPH)</dd></dl>
Expand Down
25 changes: 15 additions & 10 deletions docs/html/d0/df2/classCXXGRAPH_1_1Graph.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<td id="projectlogo"><img alt="Logo" src="../../logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">CXXGraph
&#160;<span id="projectnumber">0.1.2</span>
&#160;<span id="projectnumber">0.1.3</span>
</div>
<div id="projectbrief">CXXGraph is a small library, header only, that manages the Graph and it&#39;s algorithm in C++</div>
</td>
Expand Down Expand Up @@ -100,13 +100,15 @@
, <b>ALG_1</b>
, <b>ALG_2</b>
}</td></tr>
<tr class="memdesc:a1549d3208d57a922c72d0885894f1c32"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specify the <a class="el" href="../../d4/d32/classCXXGRAPH_1_1Partition.html">Partition</a> Algorithm. <a href="../../d0/df2/classCXXGRAPH_1_1Graph.html#a1549d3208d57a922c72d0885894f1c32">More...</a><br /></td></tr>
<tr class="separator:a1549d3208d57a922c72d0885894f1c32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41742703923f919470b2ca1496b124d6"><td class="memItemLeft" align="right" valign="top"><a id="a41742703923f919470b2ca1496b124d6"></a>
typedef enum <a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html#af40584c5cd15ce35ad36a736b3429c71">CXXGRAPH::Graph::E_InputOutputFormat</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html#a41742703923f919470b2ca1496b124d6">InputOutputFormat</a></td></tr>
<tr class="memdesc:a41742703923f919470b2ca1496b124d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specify the Input/Output format of the <a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html">Graph</a> for Import/Export functions. <br /></td></tr>
<tr class="separator:a41742703923f919470b2ca1496b124d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3df0188b5897ee4404982a27cd543485"><td class="memItemLeft" align="right" valign="top"><a id="a3df0188b5897ee4404982a27cd543485"></a>
typedef enum <a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html#a1549d3208d57a922c72d0885894f1c32">CXXGRAPH::Graph::E_PartitionAlgorithm</a>&#160;</td><td class="memItemRight" valign="bottom"><b>PartitionAlgorithm</b></td></tr>
typedef enum <a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html#a1549d3208d57a922c72d0885894f1c32">CXXGRAPH::Graph::E_PartitionAlgorithm</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html#a3df0188b5897ee4404982a27cd543485">PartitionAlgorithm</a></td></tr>
<tr class="memdesc:a3df0188b5897ee4404982a27cd543485"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specify the <a class="el" href="../../d4/d32/classCXXGRAPH_1_1Partition.html">Partition</a> Algorithm. <br /></td></tr>
<tr class="separator:a3df0188b5897ee4404982a27cd543485"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Expand All @@ -133,7 +135,8 @@
const std::optional&lt; const <a class="el" href="../../d7/d2a/classCXXGRAPH_1_1Edge.html">Edge</a>&lt; T &gt; * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>getEdge</b> (unsigned long edgeId) const</td></tr>
<tr class="separator:a4671c249cc900ab644b9142e1deaa534"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad000477b7a25ea7bfd1edf589133b042"><td class="memItemLeft" align="right" valign="top"><a id="ad000477b7a25ea7bfd1edf589133b042"></a>
const AdjacencyMatrix&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>getAdjMatrix</b> () const</td></tr>
const AdjacencyMatrix&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html#ad000477b7a25ea7bfd1edf589133b042">getAdjMatrix</a> () const</td></tr>
<tr class="memdesc:ad000477b7a25ea7bfd1edf589133b042"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function generate a list of adjacency matrix with every element of the matrix contain the node where is directed the link and the <a class="el" href="../../d7/d2a/classCXXGRAPH_1_1Edge.html">Edge</a> corrispondent to the link. <br /></td></tr>
<tr class="separator:ad000477b7a25ea7bfd1edf589133b042"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d655cd624cedf47ee366d8c0ab31921"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="../../dd/d6c/structCXXGRAPH_1_1DijkstraResult__struct.html">DijkstraResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html#a8d655cd624cedf47ee366d8c0ab31921">dijkstra</a> (const <a class="el" href="../../d3/dd2/classCXXGRAPH_1_1Node.html">Node</a>&lt; T &gt; &amp;source, const <a class="el" href="../../d3/dd2/classCXXGRAPH_1_1Node.html">Node</a>&lt; T &gt; &amp;target) const</td></tr>
<tr class="memdesc:a8d655cd624cedf47ee366d8c0ab31921"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function runs the dijkstra algorithm for some source node and target node in the graph and returns the shortest distance of target from the source. <a href="../../d0/df2/classCXXGRAPH_1_1Graph.html#a8d655cd624cedf47ee366d8c0ab31921">More...</a><br /></td></tr>
Expand All @@ -159,9 +162,9 @@
<tr class="memitem:abd5baeb88c2b588c14383155fff4ec3e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html#abd5baeb88c2b588c14383155fff4ec3e">readFromFile</a> (<a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html#a41742703923f919470b2ca1496b124d6">InputOutputFormat</a> format=InputOutputFormat::STANDARD_CSV, const std::string &amp;workingDir=&quot;.&quot;, const std::string &amp;OFileName=&quot;graph&quot;, bool compress=false, bool readNodeFeat=false, bool readEdgeWeight=false)</td></tr>
<tr class="memdesc:abd5baeb88c2b588c14383155fff4ec3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function write the graph in an output file. <a href="../../d0/df2/classCXXGRAPH_1_1Graph.html#abd5baeb88c2b588c14383155fff4ec3e">More...</a><br /></td></tr>
<tr class="separator:abd5baeb88c2b588c14383155fff4ec3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3f9c195dead42bd029b8c4cb9eb27a6"><td class="memItemLeft" align="right" valign="top">std::map&lt; unsigned int, <a class="el" href="../../d4/d32/classCXXGRAPH_1_1Partition.html">Partition</a>&lt; T &gt; * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html#ac3f9c195dead42bd029b8c4cb9eb27a6">partitionGraph</a> (PartitionAlgorithm algorithm, unsigned int numberOfPartitions) const</td></tr>
<tr class="memdesc:ac3f9c195dead42bd029b8c4cb9eb27a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function partition a graph in a set of partitions. <a href="../../d0/df2/classCXXGRAPH_1_1Graph.html#ac3f9c195dead42bd029b8c4cb9eb27a6">More...</a><br /></td></tr>
<tr class="separator:ac3f9c195dead42bd029b8c4cb9eb27a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb1d335334b510d037729719e8f579b6"><td class="memItemLeft" align="right" valign="top">PartitionMap&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html#abb1d335334b510d037729719e8f579b6">partitionGraph</a> (<a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html#a3df0188b5897ee4404982a27cd543485">PartitionAlgorithm</a> algorithm, unsigned int numberOfPartitions) const</td></tr>
<tr class="memdesc:abb1d335334b510d037729719e8f579b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function partition a graph in a set of partitions. <a href="../../d0/df2/classCXXGRAPH_1_1Graph.html#abb1d335334b510d037729719e8f579b6">More...</a><br /></td></tr>
<tr class="separator:abb1d335334b510d037729719e8f579b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
Expand Down Expand Up @@ -210,6 +213,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a1549d3208d57a922c72d0885
</tr>
</table>
</div><div class="memdoc">

<p>Specify the <a class="el" href="../../d4/d32/classCXXGRAPH_1_1Partition.html">Partition</a> Algorithm. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a1549d3208d57a922c72d0885894f1c32acc15214a985a3049a81a874878ffbabb"></a>GREEDY_VC&#160;</td><td class="fielddoc"><p>A Greedy Vertex-Cut Algorithm. </p>
</td></tr>
Expand Down Expand Up @@ -373,18 +378,18 @@ <h2 class="memtitle"><span class="permalink"><a href="#a5c7ddb5c91f3ab7456c8203a

</div>
</div>
<a id="ac3f9c195dead42bd029b8c4cb9eb27a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac3f9c195dead42bd029b8c4cb9eb27a6">&#9670;&nbsp;</a></span>partitionGraph()</h2>
<a id="abb1d335334b510d037729719e8f579b6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb1d335334b510d037729719e8f579b6">&#9670;&nbsp;</a></span>partitionGraph()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="memname">
<tr>
<td class="memname">std::map&lt; unsigned int, <a class="el" href="../../d4/d32/classCXXGRAPH_1_1Partition.html">Partition</a>&lt; T &gt; * &gt; <a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html">CXXGRAPH::Graph</a>&lt; T &gt;::partitionGraph </td>
<td class="memname">PartitionMap&lt; T &gt; <a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html">CXXGRAPH::Graph</a>&lt; T &gt;::partitionGraph </td>
<td>(</td>
<td class="paramtype">PartitionAlgorithm&#160;</td>
<td class="paramtype"><a class="el" href="../../d0/df2/classCXXGRAPH_1_1Graph.html#a3df0188b5897ee4404982a27cd543485">PartitionAlgorithm</a>&#160;</td>
<td class="paramname"><em>algorithm</em>, </td>
</tr>
<tr>
Expand Down
Loading

0 comments on commit de86eda

Please sign in to comment.