Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Update #232

Merged
merged 1 commit into from
Oct 7, 2022
Merged

Documentation Update #232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 35 additions & 37 deletions docs/html/annotated.html
View file
Open in desktop

Large diffs are not rendered by default.

141 changes: 52 additions & 89 deletions docs/html/classes.html
View file
Open in desktop

Large diffs are not rendered by default.

10 changes: 4 additions & 6 deletions docs/html/d0/d0d/classCXXGRAPH_1_1Writer-members.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>CXXGraph: Member List</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
Expand Down Expand Up @@ -32,10 +32,10 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
var searchBox = new SearchBox("searchBox", "../../search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
Expand Down Expand Up @@ -79,9 +79,7 @@
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.17
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.1
</small></address>
</body>
</html>
20 changes: 9 additions & 11 deletions docs/html/d0/d70/classCXXGRAPH_1_1PARTITIONING_1_1CoordinatedPartitionState.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>CXXGraph: CXXGRAPH::PARTITIONING::CoordinatedPartitionState&lt; T &gt; Class Template Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
Expand Down Expand Up @@ -32,10 +32,10 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
var searchBox = new SearchBox("searchBox", "../../search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
Expand Down Expand Up @@ -78,17 +78,17 @@
<div class="dynheader">
Inheritance diagram for CXXGRAPH::PARTITIONING::CoordinatedPartitionState&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="../../d0/d69/classCXXGRAPH_1_1PARTITIONING_1_1CoordinatedPartitionState__inherit__graph.png" border="0" usemap="#CXXGRAPH_1_1PARTITIONING_1_1CoordinatedPartitionState_3_01T_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="CXXGRAPH_1_1PARTITIONING_1_1CoordinatedPartitionState_3_01T_01_4_inherit__map" id="CXXGRAPH_1_1PARTITIONING_1_1CoordinatedPartitionState_3_01T_01_4_inherit__map">
<div class="center"><img src="../../d0/d69/classCXXGRAPH_1_1PARTITIONING_1_1CoordinatedPartitionState__inherit__graph.png" border="0" usemap="#aCXXGRAPH_1_1PARTITIONING_1_1CoordinatedPartitionState_3_01T_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="aCXXGRAPH_1_1PARTITIONING_1_1CoordinatedPartitionState_3_01T_01_4_inherit__map" id="aCXXGRAPH_1_1PARTITIONING_1_1CoordinatedPartitionState_3_01T_01_4_inherit__map">
<area shape="rect" title=" " alt="" coords="5,95,212,136"/>
<area shape="rect" href="../../df/d6f/classCXXGRAPH_1_1PARTITIONING_1_1PartitionState.html" title=" " alt="" coords="10,5,207,47"/>
</map>
<center><span class="legend">[<a href="../../graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for CXXGRAPH::PARTITIONING::CoordinatedPartitionState&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="../../da/de0/classCXXGRAPH_1_1PARTITIONING_1_1CoordinatedPartitionState__coll__graph.png" border="0" usemap="#CXXGRAPH_1_1PARTITIONING_1_1CoordinatedPartitionState_3_01T_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="CXXGRAPH_1_1PARTITIONING_1_1CoordinatedPartitionState_3_01T_01_4_coll__map" id="CXXGRAPH_1_1PARTITIONING_1_1CoordinatedPartitionState_3_01T_01_4_coll__map">
<div class="center"><img src="../../da/de0/classCXXGRAPH_1_1PARTITIONING_1_1CoordinatedPartitionState__coll__graph.png" border="0" usemap="#aCXXGRAPH_1_1PARTITIONING_1_1CoordinatedPartitionState_3_01T_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="aCXXGRAPH_1_1PARTITIONING_1_1CoordinatedPartitionState_3_01T_01_4_coll__map" id="aCXXGRAPH_1_1PARTITIONING_1_1CoordinatedPartitionState_3_01T_01_4_coll__map">
<area shape="rect" title=" " alt="" coords="5,95,212,136"/>
<area shape="rect" href="../../df/d6f/classCXXGRAPH_1_1PARTITIONING_1_1PartitionState.html" title=" " alt="" coords="10,5,207,47"/>
</map>
Expand Down Expand Up @@ -140,14 +140,12 @@
<tr class="separator:a93918d4c7ea90d81cf0e59fff95a8236"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/workspaces/CXXGraph/include/Partitioning/<a class="el" href="../../de/de1/CoordinatedPartitionState_8hpp_source.html">CoordinatedPartitionState.hpp</a></li>
<li>/github/workspace/include/Partitioning/<a class="el" href="../../de/de1/CoordinatedPartitionState_8hpp_source.html">CoordinatedPartitionState.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.17
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.1
</small></address>
</body>
</html>
10 changes: 4 additions & 6 deletions docs/html/d0/dca/classCXXGRAPH_1_1Reader-members.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>CXXGraph: Member List</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
Expand Down Expand Up @@ -32,10 +32,10 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
var searchBox = new SearchBox("searchBox", "../../search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
Expand Down Expand Up @@ -77,9 +77,7 @@
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.17
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.1
</small></address>
</body>
</html>
10 changes: 4 additions & 6 deletions docs/html/d0/de2/structCXXGRAPH_1_1csv__whitespace-members.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>CXXGraph: Member List</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
Expand Down Expand Up @@ -32,10 +32,10 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
var searchBox = new SearchBox("searchBox", "../../search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
Expand Down Expand Up @@ -80,9 +80,7 @@
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.17
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.1
</small></address>
</body>
</html>
21 changes: 14 additions & 7 deletions docs/html/d0/df2/classCXXGRAPH_1_1Graph.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>CXXGraph: CXXGRAPH::Graph&lt; T &gt; Class Template Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
Expand Down Expand Up @@ -32,10 +32,10 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
var searchBox = new SearchBox("searchBox", "../../search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
Expand Down Expand Up @@ -81,6 +81,15 @@
<a href="../../d0/df2/classCXXGRAPH_1_1Graph.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="../../d9/d69/Graph_8hpp_source.html">Graph.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for CXXGRAPH::Graph&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="../../dc/d80/classCXXGRAPH_1_1Graph__inherit__graph.png" border="0" usemap="#aCXXGRAPH_1_1Graph_3_01T_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="aCXXGRAPH_1_1Graph_3_01T_01_4_inherit__map" id="aCXXGRAPH_1_1Graph_3_01T_01_4_inherit__map">
<area shape="rect" title="Class that implement the Graph. ( This class is not Thread Safe )" alt="" coords="21,5,187,32"/>
<area shape="rect" href="../../de/d59/classCXXGRAPH_1_1PARTITIONING_1_1Partition.html" title=" " alt="" coords="5,80,203,121"/>
</map>
<center><span class="legend">[<a href="../../graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
Expand Down Expand Up @@ -1448,14 +1457,12 @@ <h2 class="memtitle"><span class="permalink"><a href="#a5a1ffeb9ef3b62b38c10bd84
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/workspaces/CXXGraph/include/Graph/<a class="el" href="../../d9/d69/Graph_8hpp_source.html">Graph.hpp</a></li>
<li>/github/workspace/include/Graph/<a class="el" href="../../d9/d69/Graph_8hpp_source.html">Graph.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.17
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.1
</small></address>
</body>
</html>
10 changes: 4 additions & 6 deletions docs/html/d1/d0d/classCXXGRAPH_1_1PARTITIONING_1_1Globals-members.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>CXXGraph: Member List</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
Expand Down Expand Up @@ -32,10 +32,10 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
var searchBox = new SearchBox("searchBox", "../../search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
Expand Down Expand Up @@ -92,9 +92,7 @@
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.17
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.1
</small></address>
</body>
</html>
20 changes: 9 additions & 11 deletions docs/html/d1/d63/classCXXGRAPH_1_1PARTITIONING_1_1HDRF.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>CXXGraph: CXXGRAPH::PARTITIONING::HDRF&lt; T &gt; Class Template Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
Expand Down Expand Up @@ -32,10 +32,10 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
var searchBox = new SearchBox("searchBox", "../../search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
Expand Down Expand Up @@ -83,17 +83,17 @@
<div class="dynheader">
Inheritance diagram for CXXGRAPH::PARTITIONING::HDRF&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="../../df/d27/classCXXGRAPH_1_1PARTITIONING_1_1HDRF__inherit__graph.png" border="0" usemap="#CXXGRAPH_1_1PARTITIONING_1_1HDRF_3_01T_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="CXXGRAPH_1_1PARTITIONING_1_1HDRF_3_01T_01_4_inherit__map" id="CXXGRAPH_1_1PARTITIONING_1_1HDRF_3_01T_01_4_inherit__map">
<div class="center"><img src="../../df/d27/classCXXGRAPH_1_1PARTITIONING_1_1HDRF__inherit__graph.png" border="0" usemap="#aCXXGRAPH_1_1PARTITIONING_1_1HDRF_3_01T_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="aCXXGRAPH_1_1PARTITIONING_1_1HDRF_3_01T_01_4_inherit__map" id="aCXXGRAPH_1_1PARTITIONING_1_1HDRF_3_01T_01_4_inherit__map">
<area shape="rect" title="A Vertex Cut Partioning Algorithm ( as described by this paper https://www.fabiopetroni...." alt="" coords="5,95,203,136"/>
<area shape="rect" href="../../de/deb/classCXXGRAPH_1_1PARTITIONING_1_1PartitionStrategy.html" title=" " alt="" coords="5,5,203,47"/>
</map>
<center><span class="legend">[<a href="../../graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for CXXGRAPH::PARTITIONING::HDRF&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="../../d9/d11/classCXXGRAPH_1_1PARTITIONING_1_1HDRF__coll__graph.png" border="0" usemap="#CXXGRAPH_1_1PARTITIONING_1_1HDRF_3_01T_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="CXXGRAPH_1_1PARTITIONING_1_1HDRF_3_01T_01_4_coll__map" id="CXXGRAPH_1_1PARTITIONING_1_1HDRF_3_01T_01_4_coll__map">
<div class="center"><img src="../../d9/d11/classCXXGRAPH_1_1PARTITIONING_1_1HDRF__coll__graph.png" border="0" usemap="#aCXXGRAPH_1_1PARTITIONING_1_1HDRF_3_01T_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="aCXXGRAPH_1_1PARTITIONING_1_1HDRF_3_01T_01_4_coll__map" id="aCXXGRAPH_1_1PARTITIONING_1_1HDRF_3_01T_01_4_coll__map">
<area shape="rect" title="A Vertex Cut Partioning Algorithm ( as described by this paper https://www.fabiopetroni...." alt="" coords="5,95,203,136"/>
<area shape="rect" href="../../de/deb/classCXXGRAPH_1_1PARTITIONING_1_1PartitionStrategy.html" title=" " alt="" coords="5,5,203,47"/>
</map>
Expand All @@ -115,14 +115,12 @@
<p>A Vertex Cut Partioning Algorithm ( as described by this paper <a href="https://www.fabiopetroni.com/Download/petroni2015HDRF.pdf">https://www.fabiopetroni.com/Download/petroni2015HDRF.pdf</a> ) </p>
<p>This algorithm is a greedy algorithm that partitions the graph into n sets of vertices ( as described by this paper <a href="https://www.fabiopetroni.com/Download/petroni2015HDRF.pdf">https://www.fabiopetroni.com/Download/petroni2015HDRF.pdf</a> ). </p>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>/workspaces/CXXGraph/include/Partitioning/<a class="el" href="../../d2/df2/HDRF_8hpp_source.html">HDRF.hpp</a></li>
<li>/github/workspace/include/Partitioning/<a class="el" href="../../d2/df2/HDRF_8hpp_source.html">HDRF.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.17
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.1
</small></address>
</body>
</html>
Loading