a00010.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
  2. <html>
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
  5. <title>GTL - Graph Template Library: edge Class Reference</title>
  6. <link href="doxygen.css" rel="stylesheet" type="text/css">
  7. </head>
  8. <body>
  9. <p class="links">
  10. <a href="../index.html">Home</a> |
  11. Documentation |
  12. <a href="../register.html">Download</a> |
  13. <a href="../platforms.html">Platforms</a> |
  14. <a href="../refer.html">Projects</a> |
  15. <a href="../lists.html">Mailing Lists</a> |
  16. <a href="../history.html">Version History</a>
  17. </p>
  18. <!-- Generated by Doxygen 1.5.3 -->
  19. <div class="tabs">
  20. <ul>
  21. <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  22. <li class="current"><a href="classes.html"><span>Classes</span></a></li>
  23. <li><a href="files.html"><span>Files</span></a></li>
  24. <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  25. </ul>
  26. </div>
  27. <div class="tabs">
  28. <ul>
  29. <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
  30. <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
  31. <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
  32. <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  33. </ul>
  34. </div>
  35. <h1>edge Class Reference</h1><!-- doxytag: class="edge" -->An <a class="el" href="a00010.html" title="An edge in a graph.">edge</a> in a <a class="el" href="a00014.html" title="A directed or undirected graph.">graph</a>.
  36. <a href="#_details">More...</a>
  37. <p>
  38. <p>
  39. <a href="a00141.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
  40. <tr><td></td></tr>
  41. <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  42. <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00010.html#c8047a0d7c1e08a4063be409c6fd0a88">edge</a> ()</td></tr>
  43. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00020.html">node</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00010.html#82ccce41cd94fa893ba389aa5e88be53">source</a> () const </td></tr>
  44. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00020.html">node</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00010.html#713b79cfb3a86a703f7d39ad9e1801c7">target</a> () const </td></tr>
  45. <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00010.html#d62516eb40dbee9f57a2078cfd97b4c9">reverse</a> ()</td></tr>
  46. <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00010.html#d9e615b1a11bbc88aae2b166d377f354">change_source</a> (<a class="el" href="a00020.html">node</a> n)</td></tr>
  47. <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00010.html#2f797fda0f41412265d793982f2cf953">change_target</a> (<a class="el" href="a00020.html">node</a> n)</td></tr>
  48. <tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="a00020.html">node</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00010.html#4a02e493cf05a2295f6eec47eb1498f3">opposite</a> (<a class="el" href="a00020.html">node</a> n) const </td></tr>
  49. <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00010.html#c34fb0fa24087002d4465d8fca6cd23d">is_hidden</a> () const </td></tr>
  50. <tr><td colspan="2"><br><h2>Friends</h2></td></tr>
  51. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b8b0dbc1b36724e5e4635ac651c218cb"></a><!-- doxytag: member="edge::graph" ref="b8b0dbc1b36724e5e4635ac651c218cb" args="" -->
  52. class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00010.html#b8b0dbc1b36724e5e4635ac651c218cb">graph</a></td></tr>
  53. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3700a7180235e9a28534b15d5922de12"></a><!-- doxytag: member="edge::node" ref="3700a7180235e9a28534b15d5922de12" args="" -->
  54. class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00010.html#3700a7180235e9a28534b15d5922de12">node</a></td></tr>
  55. </table>
  56. <hr><a name="_details"></a><h2>Detailed Description</h2>
  57. An <a class="el" href="a00010.html" title="An edge in a graph.">edge</a> in a <a class="el" href="a00014.html" title="A directed or undirected graph.">graph</a>. <hr><h2>Constructor &amp; Destructor Documentation</h2>
  58. <a class="anchor" name="c8047a0d7c1e08a4063be409c6fd0a88"></a><!-- doxytag: member="edge::edge" ref="c8047a0d7c1e08a4063be409c6fd0a88" args="()" -->
  59. <div class="memitem">
  60. <div class="memproto">
  61. <table class="memname">
  62. <tr>
  63. <td class="memname">edge::edge </td>
  64. <td>(</td>
  65. <td class="paramname"> </td>
  66. <td>&nbsp;)&nbsp;</td>
  67. <td width="100%"></td>
  68. </tr>
  69. </table>
  70. </div>
  71. <div class="memdoc">
  72. <p>
  73. Default constructor. Creates an invalid <a class="el" href="a00010.html" title="An edge in a graph.">edge</a>. The only way to obtain a valid <a class="el" href="a00010.html" title="An edge in a graph.">edge</a> is through <a class="el" href="a00014.html#cf88b7da133b1a1188ec8de62f0cf246">graph::new_edge</a>. Example: <pre>
  74. <a class="el" href="a00014.html" title="A directed or undirected graph.">graph</a> g;
  75. <a class="el" href="a00020.html" title="A node in a graph.">node</a> n1, n2;
  76. <a class="el" href="a00010.html" title="An edge in a graph.">edge</a> e;</pre><p>
  77. <pre> n1 = g.new_node();
  78. n2 = g.new_node();
  79. e = g.new_edge(n1, n2);
  80. </pre><p>
  81. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00014.html#cf88b7da133b1a1188ec8de62f0cf246">graph::new_edge</a> </dd></dl>
  82. </div>
  83. </div><p>
  84. <hr><h2>Member Function Documentation</h2>
  85. <a class="anchor" name="82ccce41cd94fa893ba389aa5e88be53"></a><!-- doxytag: member="edge::source" ref="82ccce41cd94fa893ba389aa5e88be53" args="() const " -->
  86. <div class="memitem">
  87. <div class="memproto">
  88. <table class="memname">
  89. <tr>
  90. <td class="memname"><a class="el" href="a00020.html">node</a> edge::source </td>
  91. <td>(</td>
  92. <td class="paramname"> </td>
  93. <td>&nbsp;)&nbsp;</td>
  94. <td width="100%"> const</td>
  95. </tr>
  96. </table>
  97. </div>
  98. <div class="memdoc">
  99. <p>
  100. Returns the source <a class="el" href="a00020.html" title="A node in a graph.">node</a> of the <a class="el" href="a00010.html" title="An edge in a graph.">edge</a>.<p>
  101. <dl class="return" compact><dt><b>Returns:</b></dt><dd>source </dd></dl>
  102. </div>
  103. </div><p>
  104. <a class="anchor" name="713b79cfb3a86a703f7d39ad9e1801c7"></a><!-- doxytag: member="edge::target" ref="713b79cfb3a86a703f7d39ad9e1801c7" args="() const " -->
  105. <div class="memitem">
  106. <div class="memproto">
  107. <table class="memname">
  108. <tr>
  109. <td class="memname"><a class="el" href="a00020.html">node</a> edge::target </td>
  110. <td>(</td>
  111. <td class="paramname"> </td>
  112. <td>&nbsp;)&nbsp;</td>
  113. <td width="100%"> const</td>
  114. </tr>
  115. </table>
  116. </div>
  117. <div class="memdoc">
  118. <p>
  119. Returns the target <a class="el" href="a00020.html" title="A node in a graph.">node</a> of the <a class="el" href="a00010.html" title="An edge in a graph.">edge</a>.<p>
  120. <dl class="return" compact><dt><b>Returns:</b></dt><dd>target </dd></dl>
  121. </div>
  122. </div><p>
  123. <a class="anchor" name="d62516eb40dbee9f57a2078cfd97b4c9"></a><!-- doxytag: member="edge::reverse" ref="d62516eb40dbee9f57a2078cfd97b4c9" args="()" -->
  124. <div class="memitem">
  125. <div class="memproto">
  126. <table class="memname">
  127. <tr>
  128. <td class="memname">void edge::reverse </td>
  129. <td>(</td>
  130. <td class="paramname"> </td>
  131. <td>&nbsp;)&nbsp;</td>
  132. <td width="100%"></td>
  133. </tr>
  134. </table>
  135. </div>
  136. <div class="memdoc">
  137. <p>
  138. Changes the direction of this <a class="el" href="a00010.html" title="An edge in a graph.">edge</a>.
  139. </div>
  140. </div><p>
  141. <a class="anchor" name="d9e615b1a11bbc88aae2b166d377f354"></a><!-- doxytag: member="edge::change_source" ref="d9e615b1a11bbc88aae2b166d377f354" args="(node n)" -->
  142. <div class="memitem">
  143. <div class="memproto">
  144. <table class="memname">
  145. <tr>
  146. <td class="memname">void edge::change_source </td>
  147. <td>(</td>
  148. <td class="paramtype"><a class="el" href="a00020.html">node</a>&nbsp;</td>
  149. <td class="paramname"> <em>n</em> </td>
  150. <td>&nbsp;)&nbsp;</td>
  151. <td width="100%"></td>
  152. </tr>
  153. </table>
  154. </div>
  155. <div class="memdoc">
  156. <p>
  157. Makes <code>n</code> the source of this <a class="el" href="a00010.html" title="An edge in a graph.">edge</a>. Takes O(1) time.<p>
  158. <dl compact><dt><b>Parameters:</b></dt><dd>
  159. <table border="0" cellspacing="2" cellpadding="0">
  160. <tr><td valign="top"></td><td valign="top"><em>&lt;code&gt;n&lt;/code&gt;</em>&nbsp;</td><td>new source </td></tr>
  161. </table>
  162. </dl>
  163. </div>
  164. </div><p>
  165. <a class="anchor" name="2f797fda0f41412265d793982f2cf953"></a><!-- doxytag: member="edge::change_target" ref="2f797fda0f41412265d793982f2cf953" args="(node n)" -->
  166. <div class="memitem">
  167. <div class="memproto">
  168. <table class="memname">
  169. <tr>
  170. <td class="memname">void edge::change_target </td>
  171. <td>(</td>
  172. <td class="paramtype"><a class="el" href="a00020.html">node</a>&nbsp;</td>
  173. <td class="paramname"> <em>n</em> </td>
  174. <td>&nbsp;)&nbsp;</td>
  175. <td width="100%"></td>
  176. </tr>
  177. </table>
  178. </div>
  179. <div class="memdoc">
  180. <p>
  181. Makes <code>n</code> the target of this <a class="el" href="a00010.html" title="An edge in a graph.">edge</a>. Takes O(1) time.<p>
  182. <dl compact><dt><b>Parameters:</b></dt><dd>
  183. <table border="0" cellspacing="2" cellpadding="0">
  184. <tr><td valign="top"></td><td valign="top"><em>&lt;code&gt;n&lt;/code&gt;</em>&nbsp;</td><td>new target </td></tr>
  185. </table>
  186. </dl>
  187. </div>
  188. </div><p>
  189. <a class="anchor" name="4a02e493cf05a2295f6eec47eb1498f3"></a><!-- doxytag: member="edge::opposite" ref="4a02e493cf05a2295f6eec47eb1498f3" args="(node n) const " -->
  190. <div class="memitem">
  191. <div class="memproto">
  192. <table class="memname">
  193. <tr>
  194. <td class="memname">const <a class="el" href="a00020.html">node</a>&amp; edge::opposite </td>
  195. <td>(</td>
  196. <td class="paramtype"><a class="el" href="a00020.html">node</a>&nbsp;</td>
  197. <td class="paramname"> <em>n</em> </td>
  198. <td>&nbsp;)&nbsp;</td>
  199. <td width="100%"> const</td>
  200. </tr>
  201. </table>
  202. </div>
  203. <div class="memdoc">
  204. <p>
  205. Returns the <a class="el" href="a00020.html" title="A node in a graph.">node</a> opposite to <code>n</code> referring to this <a class="el" href="a00010.html" title="An edge in a graph.">edge</a>.<p>
  206. <dl compact><dt><b>Parameters:</b></dt><dd>
  207. <table border="0" cellspacing="2" cellpadding="0">
  208. <tr><td valign="top"></td><td valign="top"><em>&lt;code&gt;n&lt;/code&gt;</em>&nbsp;</td><td>a <a class="el" href="a00020.html" title="A node in a graph.">node</a> incident to this <a class="el" href="a00010.html" title="An edge in a graph.">edge</a> </td></tr>
  209. </table>
  210. </dl>
  211. </div>
  212. </div><p>
  213. <a class="anchor" name="c34fb0fa24087002d4465d8fca6cd23d"></a><!-- doxytag: member="edge::is_hidden" ref="c34fb0fa24087002d4465d8fca6cd23d" args="() const " -->
  214. <div class="memitem">
  215. <div class="memproto">
  216. <table class="memname">
  217. <tr>
  218. <td class="memname">bool edge::is_hidden </td>
  219. <td>(</td>
  220. <td class="paramname"> </td>
  221. <td>&nbsp;)&nbsp;</td>
  222. <td width="100%"> const</td>
  223. </tr>
  224. </table>
  225. </div>
  226. <div class="memdoc">
  227. <p>
  228. Returns true iff <a class="el" href="a00020.html" title="A node in a graph.">node</a> is hidden.<p>
  229. <dl class="return" compact><dt><b>Returns:</b></dt><dd>true iff <a class="el" href="a00020.html" title="A node in a graph.">node</a> is hidden. </dd></dl>
  230. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00014.html#b2f8520bcac080d73c55228fecc61825">graph::hide_edge</a> <p>
  231. <a class="el" href="a00014.html#2e5426682a0897b9f9104b019970bedc">graph::restore_edge</a> </dd></dl>
  232. </div>
  233. </div><p>
  234. <p class="links">
  235. <a href="http://www.uni-passau.de/">University of Passau</a>
  236. &nbsp;-&nbsp;
  237. <a href="http://www.fmi.uni-passau.de/">FMI</a>
  238. &nbsp;-&nbsp;
  239. <a href="http://www.fmi.uni-passau.de/fmi/lehrstuehle/brandenburg/">Theoretical
  240. Computer Science</a>
  241. </p>
  242. <div class="copyright">
  243. Design &copy; 2002, 2003 <a href="mailto:raitner@fmi.uni-passau.de">Marcus Raitner</a>, University of Passau
  244. </div>
  245. </body>
  246. </html>