classalgo_1_1KShortestPaths.html 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.12"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Tracore: algo::KShortestPaths Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <script type="text/javascript">
  16. $(document).ready(function() { init_search(); });
  17. </script>
  18. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  19. </head>
  20. <body>
  21. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  22. <div id="titlearea">
  23. <table cellspacing="0" cellpadding="0">
  24. <tbody>
  25. <tr style="height: 56px;">
  26. <td id="projectalign" style="padding-left: 0.5em;">
  27. <div id="projectname">Tracore
  28. </div>
  29. </td>
  30. </tr>
  31. </tbody>
  32. </table>
  33. </div>
  34. <!-- end header part -->
  35. <!-- Generated by Doxygen 1.8.12 -->
  36. <script type="text/javascript">
  37. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  38. </script>
  39. <div id="navrow1" class="tabs">
  40. <ul class="tablist">
  41. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  42. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. <div id="navrow2" class="tabs2">
  63. <ul class="tablist">
  64. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  65. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  66. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  67. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  68. </ul>
  69. </div>
  70. <!-- window showing the filter options -->
  71. <div id="MSearchSelectWindow"
  72. onmouseover="return searchBox.OnSearchSelectShow()"
  73. onmouseout="return searchBox.OnSearchSelectHide()"
  74. onkeydown="return searchBox.OnSearchSelectKey(event)">
  75. </div>
  76. <!-- iframe showing the search results (closed by default) -->
  77. <div id="MSearchResultsWindow">
  78. <iframe src="javascript:void(0)" frameborder="0"
  79. name="MSearchResults" id="MSearchResults">
  80. </iframe>
  81. </div>
  82. <div id="nav-path" class="navpath">
  83. <ul>
  84. <li class="navelem"><b>algo</b></li><li class="navelem"><a class="el" href="classalgo_1_1KShortestPaths.html">KShortestPaths</a></li> </ul>
  85. </div>
  86. </div><!-- top -->
  87. <div class="header">
  88. <div class="summary">
  89. <a href="#pub-methods">Public Member Functions</a> &#124;
  90. <a href="classalgo_1_1KShortestPaths-members.html">List of all members</a> </div>
  91. <div class="headertitle">
  92. <div class="title">algo::KShortestPaths Class Reference</div> </div>
  93. </div><!--header-->
  94. <div class="contents">
  95. <p><code>#include &lt;<a class="el" href="KShortestPaths_8h_source.html">KShortestPaths.h</a>&gt;</code></p>
  96. <table class="memberdecls">
  97. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  98. Public Member Functions</h2></td></tr>
  99. <tr class="memitem:a2805f56b9abb112f10c752d125d623d8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classalgo_1_1KShortestPaths.html#a2805f56b9abb112f10c752d125d623d8">KShortestPaths</a> (DirectedGraph graph, Vertex source, Vertex sink)</td></tr>
  100. <tr class="separator:a2805f56b9abb112f10c752d125d623d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:ae77137136462303e951f631ba7db6adf"><td class="memItemLeft" align="right" valign="top">MultiPredecessorMap&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classalgo_1_1KShortestPaths.html#ae77137136462303e951f631ba7db6adf">Run</a> (size_t max_path_count)</td></tr>
  102. <tr class="separator:ae77137136462303e951f631ba7db6adf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. </table>
  104. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  105. <div class="textblock"><p>Class providing a k-shortest-paths algorithm implementation. </p>
  106. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  107. <a class="anchor" id="a2805f56b9abb112f10c752d125d623d8"></a>
  108. <div class="memitem">
  109. <div class="memproto">
  110. <table class="memname">
  111. <tr>
  112. <td class="memname">algo::KShortestPaths::KShortestPaths </td>
  113. <td>(</td>
  114. <td class="paramtype">DirectedGraph&#160;</td>
  115. <td class="paramname"><em>graph</em>, </td>
  116. </tr>
  117. <tr>
  118. <td class="paramkey"></td>
  119. <td></td>
  120. <td class="paramtype">Vertex&#160;</td>
  121. <td class="paramname"><em>source</em>, </td>
  122. </tr>
  123. <tr>
  124. <td class="paramkey"></td>
  125. <td></td>
  126. <td class="paramtype">Vertex&#160;</td>
  127. <td class="paramname"><em>sink</em>&#160;</td>
  128. </tr>
  129. <tr>
  130. <td></td>
  131. <td>)</td>
  132. <td></td><td></td>
  133. </tr>
  134. </table>
  135. </div><div class="memdoc">
  136. <p>Initializes the k-shortest-paths algorithm for the given graph. Uses the source vertex as starting and the sink vertex as target vertex. </p><dl class="params"><dt>Parameters</dt><dd>
  137. <table class="params">
  138. <tr><td class="paramname">graph</td><td>The graph to work with </td></tr>
  139. <tr><td class="paramname">source</td><td>The starting vertex </td></tr>
  140. <tr><td class="paramname">sink</td><td>The target vertex </td></tr>
  141. </table>
  142. </dd>
  143. </dl>
  144. </div>
  145. </div>
  146. <h2 class="groupheader">Member Function Documentation</h2>
  147. <a class="anchor" id="ae77137136462303e951f631ba7db6adf"></a>
  148. <div class="memitem">
  149. <div class="memproto">
  150. <table class="memname">
  151. <tr>
  152. <td class="memname">MultiPredecessorMap algo::KShortestPaths::Run </td>
  153. <td>(</td>
  154. <td class="paramtype">size_t&#160;</td>
  155. <td class="paramname"><em>max_path_count</em></td><td>)</td>
  156. <td></td>
  157. </tr>
  158. </table>
  159. </div><div class="memdoc">
  160. <p>Runs the algorithm to find the given number of shortest paths. The actual number of paths found is the number of entries in the MultiPredecessorMap with the sink vertex as the key. </p><dl class="params"><dt>Parameters</dt><dd>
  161. <table class="params">
  162. <tr><td class="paramname">max_path_count</td><td>The maximum number of paths to find </td></tr>
  163. </table>
  164. </dd>
  165. </dl>
  166. </div>
  167. </div>
  168. <hr/>The documentation for this class was generated from the following files:<ul>
  169. <li>algo/<a class="el" href="KShortestPaths_8h_source.html">KShortestPaths.h</a></li>
  170. <li>algo/KShortestPaths.cpp</li>
  171. </ul>
  172. </div><!-- contents -->
  173. <!-- start footer part -->
  174. <hr class="footer"/><address class="footer"><small>
  175. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  176. <img class="footer" src="doxygen.png" alt="doxygen"/>
  177. </a> 1.8.12
  178. </small></address>
  179. </body>
  180. </html>