Documentation for f1eddf4d65

This commit is contained in:
realstealthninja
2025-07-09 10:53:16 +00:00
parent e7edde96ab
commit b41207008f
2497 changed files with 31270 additions and 40283 deletions

View File

@@ -4,7 +4,7 @@
<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.13.2"/>
<meta name="generator" content="Doxygen 1.14.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>TheAlgorithms/C++: graph::RootedTree Class Reference</title>
<link rel="icon" href="../../favicon.svg" type="image/x-icon" />
@@ -19,7 +19,6 @@
<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="../../resize.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>
@@ -60,26 +59,20 @@ window.MathJax = {
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<!-- Generated by Doxygen 1.14.0 -->
<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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(1); });
/* @license-end */
$(function() { codefold.init(); });
</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',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
@@ -94,10 +87,9 @@ $(function() {
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('d0/d58/classgraph_1_1_rooted_tree.html','../../'); initResizable(true); });
/* @license-end */
$(function(){initNavTree('d0/d58/classgraph_1_1_rooted_tree.html','../../','d5/d55/classgraph_1_1_rooted_tree-members'); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
@@ -121,68 +113,53 @@ $(function(){initNavTree('d0/d58/classgraph_1_1_rooted_tree.html','../../'); ini
</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="#pro-methods">Protected Member Functions</a> &#124;
<a href="../../d5/d55/classgraph_1_1_rooted_tree-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">graph::RootedTree Class Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for graph::RootedTree:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../dd/d9b/classgraph_1_1_rooted_tree__inherit__graph.svg" width="140" height="111"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="../../dd/d9b/classgraph_1_1_rooted_tree__inherit__graph.svg" width="140" height="111"><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>
<div class="dynheader">
Collaboration diagram for graph::RootedTree:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d0/d24/classgraph_1_1_rooted_tree__coll__graph.svg" width="379" height="348"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="../../d0/d24/classgraph_1_1_rooted_tree__coll__graph.svg" width="379" height="383"><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>
<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:aacdeecac857623e9fbfe92590f3c504d" id="r_aacdeecac857623e9fbfe92590f3c504d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aacdeecac857623e9fbfe92590f3c504d">RootedTree</a> (const std::vector&lt; std::pair&lt; int, int &gt; &gt; &amp;undirected_edges, int root_)</td></tr>
<tr class="memdesc:aacdeecac857623e9fbfe92590f3c504d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs the tree by calculating parent for every vertex. Assumes a valid description of a tree is provided. <br /></td></tr>
<tr class="separator:aacdeecac857623e9fbfe92590f3c504d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classgraph_1_1_graph"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classgraph_1_1_graph')"><img src="../../closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="../../dc/d61/classgraph_1_1_graph.html">graph::Graph&lt; T &gt;</a></td></tr>
<tr class="inherit_header pub_methods_classgraph_1_1_graph"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classgraph_1_1_graph')"><span class="dynarrow"><span class="arrowhead closed"></span></span>Public Member Functions inherited from <a class="el" href="../../dc/d61/classgraph_1_1_graph.html">graph::Graph&lt; T &gt;</a></td></tr>
<tr class="memitem:a877b2cba40d8d46dde6fb4209effed19 inherit pub_methods_classgraph_1_1_graph" id="r_a877b2cba40d8d46dde6fb4209effed19"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d61/classgraph_1_1_graph.html#a877b2cba40d8d46dde6fb4209effed19">add_edge</a> (T u, T v, bool bidir=true)</td></tr>
<tr class="separator:a877b2cba40d8d46dde6fb4209effed19 inherit pub_methods_classgraph_1_1_graph"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3755ec9e6a842238c7f4aac10b661981 inherit pub_methods_classgraph_1_1_graph" id="r_a3755ec9e6a842238c7f4aac10b661981"><td class="memItemLeft" align="right" valign="top">std::map&lt; T, bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d61/classgraph_1_1_graph.html#a3755ec9e6a842238c7f4aac10b661981">breadth_first_search</a> (T src)</td></tr>
<tr class="separator:a3755ec9e6a842238c7f4aac10b661981 inherit pub_methods_classgraph_1_1_graph"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8839fa14bff19d2deab4a618447c13e5 inherit pub_methods_classgraph_1_1_graph" id="r_a8839fa14bff19d2deab4a618447c13e5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d61/classgraph_1_1_graph.html#a8839fa14bff19d2deab4a618447c13e5">Graph</a> (size_t N, const std::vector&lt; std::pair&lt; int, int &gt; &gt; &amp;undirected_edges)</td></tr>
<tr class="memdesc:a8839fa14bff19d2deab4a618447c13e5 inherit pub_methods_classgraph_1_1_graph"><td class="mdescLeft">&#160;</td><td class="mdescRight">Populate the adjacency list for each vertex in the graph. Assumes that evey edge is a pair of valid vertex indices. <br /></td></tr>
<tr class="separator:a8839fa14bff19d2deab4a618447c13e5 inherit pub_methods_classgraph_1_1_graph"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8930d1470d132b19e430d1c71f94c904 inherit pub_methods_classgraph_1_1_graph" id="r_a8930d1470d132b19e430d1c71f94c904"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d61/classgraph_1_1_graph.html#a8930d1470d132b19e430d1c71f94c904">number_of_vertices</a> () const</td></tr>
<tr class="separator:a8930d1470d132b19e430d1c71f94c904 inherit pub_methods_classgraph_1_1_graph"><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>
<tr class="heading"><td colspan="2"><h2 id="header-pub-attribs" class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a3831583a91914988897a4cc8748fda43" id="r_a3831583a91914988897a4cc8748fda43"><td class="memItemLeft" align="right" valign="top">std::vector&lt; int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3831583a91914988897a4cc8748fda43">parent</a></td></tr>
<tr class="memdesc:a3831583a91914988897a4cc8748fda43"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stores parent of every vertex and for root its own index. The root is technically not its own parent, but it's very practical for the lowest common ancestor algorithm. <br /></td></tr>
<tr class="separator:a3831583a91914988897a4cc8748fda43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ee3ad1161ac2532da30c3e22c265ad3" id="r_a2ee3ad1161ac2532da30c3e22c265ad3"><td class="memItemLeft" align="right" valign="top">std::vector&lt; int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2ee3ad1161ac2532da30c3e22c265ad3">level</a></td></tr>
<tr class="memdesc:a2ee3ad1161ac2532da30c3e22c265ad3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stores the distance from the root. <br /></td></tr>
<tr class="separator:a2ee3ad1161ac2532da30c3e22c265ad3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab22a97bf6209a085fc2d788c3c0dacbe" id="r_ab22a97bf6209a085fc2d788c3c0dacbe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab22a97bf6209a085fc2d788c3c0dacbe">root</a></td></tr>
<tr class="memdesc:ab22a97bf6209a085fc2d788c3c0dacbe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Index of the root vertex. <br /></td></tr>
<tr class="separator:ab22a97bf6209a085fc2d788c3c0dacbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_attribs_classgraph_1_1_graph"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_attribs_classgraph_1_1_graph')"><img src="../../closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="../../dc/d61/classgraph_1_1_graph.html">graph::Graph&lt; T &gt;</a></td></tr>
<tr class="inherit_header pub_attribs_classgraph_1_1_graph"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_attribs_classgraph_1_1_graph')"><span class="dynarrow"><span class="arrowhead closed"></span></span>Public Attributes inherited from <a class="el" href="../../dc/d61/classgraph_1_1_graph.html">graph::Graph&lt; T &gt;</a></td></tr>
<tr class="memitem:a59940c462861f2fcf4951d1b6c084e6a inherit pub_attribs_classgraph_1_1_graph" id="r_a59940c462861f2fcf4951d1b6c084e6a"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::vector&lt; int &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d61/classgraph_1_1_graph.html#a59940c462861f2fcf4951d1b6c084e6a">neighbors</a></td></tr>
<tr class="memdesc:a59940c462861f2fcf4951d1b6c084e6a inherit pub_attribs_classgraph_1_1_graph"><td class="mdescLeft">&#160;</td><td class="mdescRight">for each vertex it stores a list indicies of its neighbors <br /></td></tr>
<tr class="separator:a59940c462861f2fcf4951d1b6c084e6a inherit pub_attribs_classgraph_1_1_graph"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
<tr class="heading"><td colspan="2"><h2 id="header-pro-methods" class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:ae6928f3ebd491541e9570e746b877c1e" id="r_ae6928f3ebd491541e9570e746b877c1e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae6928f3ebd491541e9570e746b877c1e">populate_parents</a> ()</td></tr>
<tr class="memdesc:ae6928f3ebd491541e9570e746b877c1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate the parents for all the vertices in the tree. Implements the breadth first search algorithm starting from the root vertex searching the entire tree and labeling parents for all vertices. <br /></td></tr>
<tr class="separator:ae6928f3ebd491541e9570e746b877c1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Representation of a rooted tree. For every vertex its parent is precalculated. </p>
<p class="definition">Definition at line <a class="el" href="../../de/dde/lowest__common__ancestor_8cpp_source.html#l00084">84</a> of file <a class="el" href="../../de/dde/lowest__common__ancestor_8cpp_source.html">lowest_common_ancestor.cpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
</div><a name="doc-constructors" id="doc-constructors"></a><h2 id="header-doc-constructors" class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aacdeecac857623e9fbfe92590f3c504d" name="aacdeecac857623e9fbfe92590f3c504d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aacdeecac857623e9fbfe92590f3c504d">&#9670;&#160;</a></span>RootedTree()</h2>
@@ -228,7 +205,7 @@ Protected Member Functions</h2></td></tr>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
<a id="ae6928f3ebd491541e9570e746b877c1e" name="ae6928f3ebd491541e9570e746b877c1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6928f3ebd491541e9570e746b877c1e">&#9670;&#160;</a></span>populate_parents()</h2>
@@ -285,7 +262,7 @@ Protected Member Functions</h2></td></tr>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Member Data Documentation</h2>
<a id="a2ee3ad1161ac2532da30c3e22c265ad3" name="a2ee3ad1161ac2532da30c3e22c265ad3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ee3ad1161ac2532da30c3e22c265ad3">&#9670;&#160;</a></span>level</h2>
@@ -345,11 +322,19 @@ Protected Member Functions</h2></td></tr>
</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 class="el" href="../../df/dce/namespacegraph.html">graph</a></li><li class="navelem"><a class="el" href="../../d0/d58/classgraph_1_1_rooted_tree.html">RootedTree</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.13.2 </li>
<li class="navelem"><a href="../../df/dce/namespacegraph.html">graph</a></li><li class="navelem"><a href="../../d0/d58/classgraph_1_1_rooted_tree.html">RootedTree</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.14.0 </li>
</ul>
</div>
</body>