a00023.html 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518
  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: planarity 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>planarity Class Reference</h1><!-- doxytag: class="planarity" --><!-- doxytag: inherits="algorithm" -->Tests if a graph can be drawn on a plane without any edge crossings.
  36. <a href="#_details">More...</a>
  37. <p>
  38. <div class="dynheader">
  39. Inheritance diagram for planarity:</div>
  40. <div class="dynsection">
  41. <p><center><img src="a00188.gif" border="0" usemap="#a00189" alt="Inheritance graph"></center>
  42. <map name="a00189">
  43. <area shape="rect" href="a00001.html" title="Abstract baseclass for all algoritm&#45;classes." alt="" coords="5,7,83,31"></map>
  44. <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
  45. <div class="dynheader">
  46. Collaboration diagram for planarity:</div>
  47. <div class="dynsection">
  48. <p><center><img src="a00190.gif" border="0" usemap="#a00191" alt="Collaboration graph"></center>
  49. <map name="a00191">
  50. <area shape="rect" href="a00001.html" title="Abstract baseclass for all algoritm&#45;classes." alt="" coords="5,97,83,121"><area shape="rect" href="a00022.html" title="Ordered adjacency lists as a result of planarity testing." alt="" coords="107,97,240,121"><area shape="rect" title="embedding" alt="" coords="156,119,164,127"><area shape="rect" title="embedding" alt="" coords="95,184,103,192"><area shape="rect" href="a00014.html" title="A directed or undirected graph." alt="" coords="145,7,201,31"><area shape="rect" title="G" alt="" coords="169,28,177,36"><area shape="rect" title="G" alt="" coords="169,93,177,101"></map>
  51. <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
  52. <p>
  53. <a href="a00192.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
  54. <tr><td></td></tr>
  55. <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  56. <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#a928bc1c8d0c89b6523bc1e7456f4c91">planarity</a> ()</td></tr>
  57. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates an object of the <a class="el" href="a00023.html" title="Tests if a graph can be drawn on a plane without any edge crossings.">planarity</a> test algorithm. <a href="#a928bc1c8d0c89b6523bc1e7456f4c91"></a><br></td></tr>
  58. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3e0c0f1a724191042947dfecc640bf05"></a><!-- doxytag: member="planarity::~planarity" ref="3e0c0f1a724191042947dfecc640bf05" args="()" -->
  59. &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#3e0c0f1a724191042947dfecc640bf05">~planarity</a> ()</td></tr>
  60. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
  61. <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#e06c471d957a116aad14e338c341f8b1">check</a> (<a class="el" href="a00014.html">graph</a> &amp;G)</td></tr>
  62. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Checks whether <a class="el" href="a00023.html" title="Tests if a graph can be drawn on a plane without any edge crossings.">planarity</a> test can be applied to <code>G</code>. <a href="#e06c471d957a116aad14e338c341f8b1"></a><br></td></tr>
  63. <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#93232e765c08dd2a4c00d192bb48b5fc">run</a> (<a class="el" href="a00014.html">graph</a> &amp;G)</td></tr>
  64. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Runs <a class="el" href="a00023.html" title="Tests if a graph can be drawn on a plane without any edge crossings.">planarity</a> test on <code>G</code>. <a href="#93232e765c08dd2a4c00d192bb48b5fc"></a><br></td></tr>
  65. <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#ca500e3d46a99c6231aff86afa2a71b1">reset</a> ()</td></tr>
  66. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Resets <a class="el" href="a00001.html" title="Abstract baseclass for all algoritm-classes.">algorithm</a> object, such that it can be applied to another <a class="el" href="a00014.html" title="A directed or undirected graph.">graph</a>. <a href="#ca500e3d46a99c6231aff86afa2a71b1"></a><br></td></tr>
  67. <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#1679e285a7135b48b572764f5e8e773d">calc_embedding</a> (bool p)</td></tr>
  68. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">If <code>p</code> is true a planar embedding will be calculated in the next run. <a href="#1679e285a7135b48b572764f5e8e773d"></a><br></td></tr>
  69. <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#7806f9040f6ba20befb15ea3a25ba76a">calc_embedding</a> () const </td></tr>
  70. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if a planar embedding will be calculated in the next run. <a href="#7806f9040f6ba20befb15ea3a25ba76a"></a><br></td></tr>
  71. <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#7b8e8e5414a4eedb0f99253d3b62ffa3">calc_obstruction</a> (bool p)</td></tr>
  72. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">If <code>p</code> is true the obstructions to planarity will be calculated in the next run. <a href="#7b8e8e5414a4eedb0f99253d3b62ffa3"></a><br></td></tr>
  73. <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#16713450b2930008709b87fc4f32fc6f">calc_obstruction</a> () const </td></tr>
  74. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if the obstructions to planarity will be calculated in the next run. <a href="#16713450b2930008709b87fc4f32fc6f"></a><br></td></tr>
  75. <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#f67236533dce559d2670eae581750f54">make_biconnected</a> (bool p)</td></tr>
  76. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Determines the strategy used to test a <a class="el" href="a00014.html" title="A directed or undirected graph.">graph</a> which is not biconnected. <a href="#f67236533dce559d2670eae581750f54"></a><br></td></tr>
  77. <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#ab1a8ac05bacd090cb347340e0f9d119">make_biconnected</a> () const </td></tr>
  78. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns strategy for testing graphs, which are not biconnected. <a href="#ab1a8ac05bacd090cb347340e0f9d119"></a><br></td></tr>
  79. <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#7a623f4c0e5c753a01dab6c0a79c3b50">is_planar</a> () const </td></tr>
  80. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Result of last test. <a href="#7a623f4c0e5c753a01dab6c0a79c3b50"></a><br></td></tr>
  81. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00022.html">planar_embedding</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#9ab79a340e361c3300cc08e82edd4e12">get_embedding</a> ()</td></tr>
  82. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">If graph in last <a class="el" href="a00023.html#93232e765c08dd2a4c00d192bb48b5fc" title="Runs planarity test on G.">run</a> was planar a planar embedding is calculated during the reductions. This function gives access to it. <a href="#9ab79a340e361c3300cc08e82edd4e12"></a><br></td></tr>
  83. <tr><td class="memItemLeft" nowrap align="right" valign="top">list&lt; <a class="el" href="a00010.html">edge</a> &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#c9021696934cc24afbc36aa307b2919b">get_obstruction_edges</a> ()</td></tr>
  84. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the edges of a subgraph homeomorphic to either K3,3 or K5 if graph in last run was not planar. <a href="#c9021696934cc24afbc36aa307b2919b"></a><br></td></tr>
  85. <tr><td class="memItemLeft" nowrap align="right" valign="top">list&lt; <a class="el" href="a00020.html">node</a> &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#c1bee50e38d398f3868a3308164caa31">get_obstruction_nodes</a> ()</td></tr>
  86. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the nodes of a subgraph homeomorphic to either K3,3 or K5 if graph in last run was not planar. <a href="#c1bee50e38d398f3868a3308164caa31"></a><br></td></tr>
  87. </table>
  88. <hr><a name="_details"></a><h2>Detailed Description</h2>
  89. Tests if a graph can be drawn on a plane without any edge crossings.
  90. <p>
  91. <dl class="rcs" compact><dt><b>Date</b></dt><dd></dd></dl>
  92. <dl class="rcs" compact><dt><b>Revision</b></dt><dd></dd></dl>
  93. <p>
  94. This class implements the Lempel-Even-Cederbaum planarity test using PQ-trees. In case the graph is planar a planar embedding is obtained, i.e. for each node in the graph an ordered adjacency list is calculated, such that there exists a planar drawing in which all adjacent edges around a node apply to this order.<p>
  95. If the graph is not planar Kuratowski's famous theorem states that it must contain a subgraph hoemeomorphic to either K5 (the complete graph with five nodes) or K3,3 (the complete bipartite graph with three nodes each side). In this case the nodes and edges of the tested graph that form either of these two are calculated.<p>
  96. In case the graph is planar and has <img class="formulaInl" alt="$N$" src="form_3.png"> nodes the <a class="el" href="a00001.html" title="Abstract baseclass for all algoritm-classes.">algorithm</a> needs <img class="formulaInl" alt="$\mathcal{O}(N)$" src="form_4.png"> time for the test (including the planar embedding). In case the graph isn't planar it needs at most <img class="formulaInl" alt="$\mathcal{O}(E)$" src="form_5.png"> time if <img class="formulaInl" alt="$E$" src="form_6.png"> is the number of edges for both the test and the detection of K5 or K3,3. <hr><h2>Constructor &amp; Destructor Documentation</h2>
  97. <a class="anchor" name="a928bc1c8d0c89b6523bc1e7456f4c91"></a><!-- doxytag: member="planarity::planarity" ref="a928bc1c8d0c89b6523bc1e7456f4c91" args="()" -->
  98. <div class="memitem">
  99. <div class="memproto">
  100. <table class="memname">
  101. <tr>
  102. <td class="memname">planarity::planarity </td>
  103. <td>(</td>
  104. <td class="paramname"> </td>
  105. <td>&nbsp;)&nbsp;</td>
  106. <td width="100%"></td>
  107. </tr>
  108. </table>
  109. </div>
  110. <div class="memdoc">
  111. <p>
  112. Creates an object of the <a class="el" href="a00023.html" title="Tests if a graph can be drawn on a plane without any edge crossings.">planarity</a> test algorithm.
  113. <p>
  114. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00001.html" title="Abstract baseclass for all algoritm-classes.">algorithm</a> </dd></dl>
  115. </div>
  116. </div><p>
  117. <hr><h2>Member Function Documentation</h2>
  118. <a class="anchor" name="e06c471d957a116aad14e338c341f8b1"></a><!-- doxytag: member="planarity::check" ref="e06c471d957a116aad14e338c341f8b1" args="(graph &amp;G)" -->
  119. <div class="memitem">
  120. <div class="memproto">
  121. <table class="memname">
  122. <tr>
  123. <td class="memname">int planarity::check </td>
  124. <td>(</td>
  125. <td class="paramtype"><a class="el" href="a00014.html">graph</a> &amp;&nbsp;</td>
  126. <td class="paramname"> <em>G</em> </td>
  127. <td>&nbsp;)&nbsp;</td>
  128. <td width="100%"><code> [virtual]</code></td>
  129. </tr>
  130. </table>
  131. </div>
  132. <div class="memdoc">
  133. <p>
  134. Checks whether <a class="el" href="a00023.html" title="Tests if a graph can be drawn on a plane without any edge crossings.">planarity</a> test can be applied to <code>G</code>.
  135. <p>
  136. This should return always <code>GTL_OK</code>. There aren't any restrictions on <code>G</code>, even multiple edges and selfloops are tolerated.<p>
  137. <dl class="note" compact><dt><b>Note:</b></dt><dd>Selfloops and multiple edges will not be added to the planar embedding. <a class="el" href="a00022.html#b04859be18352bc53a120b0676a499ba">planar_embedding::selfloops</a> and <a class="el" href="a00022.html#fb50ef8f3b5b2c6690b9d364db21f36f">planar_embedding::multiple_edges</a> can be used to get these.</dd></dl>
  138. <dl compact><dt><b>Parameters:</b></dt><dd>
  139. <table border="0" cellspacing="2" cellpadding="0">
  140. <tr><td valign="top"></td><td valign="top"><em>G</em>&nbsp;</td><td>arbitrary graph</td></tr>
  141. </table>
  142. </dl>
  143. <dl compact><dt><b>Return values:</b></dt><dd>
  144. <table border="0" cellspacing="2" cellpadding="0">
  145. <tr><td valign="top"></td><td valign="top"><em>GTL_OK</em>&nbsp;</td><td>if planarity test can be applied </td></tr>
  146. <tr><td valign="top"></td><td valign="top"><em>GTL_ERROR</em>&nbsp;</td><td>if not</td></tr>
  147. </table>
  148. </dl>
  149. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00001.html#76361fb03ad1cf643affc51821e43bed" title="Checks whether all preconditions are satisfied.">algorithm::check</a> </dd></dl>
  150. <p>Implements <a class="el" href="a00001.html#76361fb03ad1cf643affc51821e43bed">algorithm</a>.</p>
  151. </div>
  152. </div><p>
  153. <a class="anchor" name="93232e765c08dd2a4c00d192bb48b5fc"></a><!-- doxytag: member="planarity::run" ref="93232e765c08dd2a4c00d192bb48b5fc" args="(graph &amp;G)" -->
  154. <div class="memitem">
  155. <div class="memproto">
  156. <table class="memname">
  157. <tr>
  158. <td class="memname">int planarity::run </td>
  159. <td>(</td>
  160. <td class="paramtype"><a class="el" href="a00014.html">graph</a> &amp;&nbsp;</td>
  161. <td class="paramname"> <em>G</em> </td>
  162. <td>&nbsp;)&nbsp;</td>
  163. <td width="100%"><code> [virtual]</code></td>
  164. </tr>
  165. </table>
  166. </div>
  167. <div class="memdoc">
  168. <p>
  169. Runs <a class="el" href="a00023.html" title="Tests if a graph can be drawn on a plane without any edge crossings.">planarity</a> test on <code>G</code>.
  170. <p>
  171. This should return always <code>GTL_OK</code>. The return value only tracks errors that might occur, it is definitly <em>not</em> the result of the test itself. The result of the test is stored in a member variable and can be accessed via <a class="el" href="a00023.html#7a623f4c0e5c753a01dab6c0a79c3b50" title="Result of last test.">is_planar</a>.<p>
  172. <dl compact><dt><b>Parameters:</b></dt><dd>
  173. <table border="0" cellspacing="2" cellpadding="0">
  174. <tr><td valign="top"></td><td valign="top"><em>G</em>&nbsp;</td><td>arbitrary graph</td></tr>
  175. </table>
  176. </dl>
  177. <dl compact><dt><b>Return values:</b></dt><dd>
  178. <table border="0" cellspacing="2" cellpadding="0">
  179. <tr><td valign="top"></td><td valign="top"><em>GTL_OK</em>&nbsp;</td><td>if planarity test was sucessfully applied </td></tr>
  180. <tr><td valign="top"></td><td valign="top"><em>GTL_ERROR</em>&nbsp;</td><td>if not</td></tr>
  181. </table>
  182. </dl>
  183. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00001.html#734b189509a8d6b56b65f8ff772d43ca" title="Applies algorithm to graph g.">algorithm::run</a> </dd></dl>
  184. <p>Implements <a class="el" href="a00001.html#734b189509a8d6b56b65f8ff772d43ca">algorithm</a>.</p>
  185. </div>
  186. </div><p>
  187. <a class="anchor" name="ca500e3d46a99c6231aff86afa2a71b1"></a><!-- doxytag: member="planarity::reset" ref="ca500e3d46a99c6231aff86afa2a71b1" args="()" -->
  188. <div class="memitem">
  189. <div class="memproto">
  190. <table class="memname">
  191. <tr>
  192. <td class="memname">void planarity::reset </td>
  193. <td>(</td>
  194. <td class="paramname"> </td>
  195. <td>&nbsp;)&nbsp;</td>
  196. <td width="100%"><code> [virtual]</code></td>
  197. </tr>
  198. </table>
  199. </div>
  200. <div class="memdoc">
  201. <p>
  202. Resets <a class="el" href="a00001.html" title="Abstract baseclass for all algoritm-classes.">algorithm</a> object, such that it can be applied to another <a class="el" href="a00014.html" title="A directed or undirected graph.">graph</a>.
  203. <p>
  204. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00001.html#21aba63d066ae7897de6ca7d8425c408" title="Resets algorithm.">algorithm::reset</a> </dd></dl>
  205. <p>Implements <a class="el" href="a00001.html#21aba63d066ae7897de6ca7d8425c408">algorithm</a>.</p>
  206. </div>
  207. </div><p>
  208. <a class="anchor" name="1679e285a7135b48b572764f5e8e773d"></a><!-- doxytag: member="planarity::calc_embedding" ref="1679e285a7135b48b572764f5e8e773d" args="(bool p)" -->
  209. <div class="memitem">
  210. <div class="memproto">
  211. <table class="memname">
  212. <tr>
  213. <td class="memname">void planarity::calc_embedding </td>
  214. <td>(</td>
  215. <td class="paramtype">bool&nbsp;</td>
  216. <td class="paramname"> <em>p</em> </td>
  217. <td>&nbsp;)&nbsp;</td>
  218. <td width="100%"><code> [inline]</code></td>
  219. </tr>
  220. </table>
  221. </div>
  222. <div class="memdoc">
  223. <p>
  224. If <code>p</code> is true a planar embedding will be calculated in the next run.
  225. <p>
  226. <dl compact><dt><b>Parameters:</b></dt><dd>
  227. <table border="0" cellspacing="2" cellpadding="0">
  228. <tr><td valign="top"></td><td valign="top"><em>p</em>&nbsp;</td><td><code>true</code> iff embedding should be calculated</td></tr>
  229. </table>
  230. </dl>
  231. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00023.html#9ab79a340e361c3300cc08e82edd4e12" title="If graph in last run was planar a planar embedding is calculated during the reductions...">get_embedding</a> <p>
  232. <a class="el" href="a00022.html" title="Ordered adjacency lists as a result of planarity testing.">planar_embedding</a> </dd></dl>
  233. </div>
  234. </div><p>
  235. <a class="anchor" name="7806f9040f6ba20befb15ea3a25ba76a"></a><!-- doxytag: member="planarity::calc_embedding" ref="7806f9040f6ba20befb15ea3a25ba76a" args="() const " -->
  236. <div class="memitem">
  237. <div class="memproto">
  238. <table class="memname">
  239. <tr>
  240. <td class="memname">bool planarity::calc_embedding </td>
  241. <td>(</td>
  242. <td class="paramname"> </td>
  243. <td>&nbsp;)&nbsp;</td>
  244. <td width="100%"> const<code> [inline]</code></td>
  245. </tr>
  246. </table>
  247. </div>
  248. <div class="memdoc">
  249. <p>
  250. Returns true if a planar embedding will be calculated in the next run.
  251. <p>
  252. <dl compact><dt><b>Return values:</b></dt><dd>
  253. <table border="0" cellspacing="2" cellpadding="0">
  254. <tr><td valign="top"></td><td valign="top"><em>true</em>&nbsp;</td><td>iff embedding will be calculated</td></tr>
  255. </table>
  256. </dl>
  257. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00023.html#9ab79a340e361c3300cc08e82edd4e12" title="If graph in last run was planar a planar embedding is calculated during the reductions...">get_embedding</a> <p>
  258. <a class="el" href="a00022.html" title="Ordered adjacency lists as a result of planarity testing.">planar_embedding</a> </dd></dl>
  259. </div>
  260. </div><p>
  261. <a class="anchor" name="7b8e8e5414a4eedb0f99253d3b62ffa3"></a><!-- doxytag: member="planarity::calc_obstruction" ref="7b8e8e5414a4eedb0f99253d3b62ffa3" args="(bool p)" -->
  262. <div class="memitem">
  263. <div class="memproto">
  264. <table class="memname">
  265. <tr>
  266. <td class="memname">void planarity::calc_obstruction </td>
  267. <td>(</td>
  268. <td class="paramtype">bool&nbsp;</td>
  269. <td class="paramname"> <em>p</em> </td>
  270. <td>&nbsp;)&nbsp;</td>
  271. <td width="100%"><code> [inline]</code></td>
  272. </tr>
  273. </table>
  274. </div>
  275. <div class="memdoc">
  276. <p>
  277. If <code>p</code> is true the obstructions to planarity will be calculated in the next run.
  278. <p>
  279. This implies the calculation of an embedding.<p>
  280. <dl compact><dt><b>Parameters:</b></dt><dd>
  281. <table border="0" cellspacing="2" cellpadding="0">
  282. <tr><td valign="top"></td><td valign="top"><em>p</em>&nbsp;</td><td><code>true</code> iff obstructions to planarity should be calculated</td></tr>
  283. </table>
  284. </dl>
  285. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00023.html#c9021696934cc24afbc36aa307b2919b" title="Returns the edges of a subgraph homeomorphic to either K3,3 or K5 if graph in last...">get_obstruction_edges</a> <p>
  286. <a class="el" href="a00023.html#c1bee50e38d398f3868a3308164caa31" title="Returns the nodes of a subgraph homeomorphic to either K3,3 or K5 if graph in last...">get_obstruction_nodes</a> </dd></dl>
  287. </div>
  288. </div><p>
  289. <a class="anchor" name="16713450b2930008709b87fc4f32fc6f"></a><!-- doxytag: member="planarity::calc_obstruction" ref="16713450b2930008709b87fc4f32fc6f" args="() const " -->
  290. <div class="memitem">
  291. <div class="memproto">
  292. <table class="memname">
  293. <tr>
  294. <td class="memname">bool planarity::calc_obstruction </td>
  295. <td>(</td>
  296. <td class="paramname"> </td>
  297. <td>&nbsp;)&nbsp;</td>
  298. <td width="100%"> const<code> [inline]</code></td>
  299. </tr>
  300. </table>
  301. </div>
  302. <div class="memdoc">
  303. <p>
  304. Returns true if the obstructions to planarity will be calculated in the next run.
  305. <p>
  306. <dl compact><dt><b>Return values:</b></dt><dd>
  307. <table border="0" cellspacing="2" cellpadding="0">
  308. <tr><td valign="top"></td><td valign="top"><em>true</em>&nbsp;</td><td>iff obstructions to planarity will be calculated</td></tr>
  309. </table>
  310. </dl>
  311. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00023.html#c9021696934cc24afbc36aa307b2919b" title="Returns the edges of a subgraph homeomorphic to either K3,3 or K5 if graph in last...">get_obstruction_edges</a> <p>
  312. <a class="el" href="a00023.html#c1bee50e38d398f3868a3308164caa31" title="Returns the nodes of a subgraph homeomorphic to either K3,3 or K5 if graph in last...">get_obstruction_nodes</a> </dd></dl>
  313. </div>
  314. </div><p>
  315. <a class="anchor" name="f67236533dce559d2670eae581750f54"></a><!-- doxytag: member="planarity::make_biconnected" ref="f67236533dce559d2670eae581750f54" args="(bool p)" -->
  316. <div class="memitem">
  317. <div class="memproto">
  318. <table class="memname">
  319. <tr>
  320. <td class="memname">void planarity::make_biconnected </td>
  321. <td>(</td>
  322. <td class="paramtype">bool&nbsp;</td>
  323. <td class="paramname"> <em>p</em> </td>
  324. <td>&nbsp;)&nbsp;</td>
  325. <td width="100%"><code> [inline]</code></td>
  326. </tr>
  327. </table>
  328. </div>
  329. <div class="memdoc">
  330. <p>
  331. Determines the strategy used to test a <a class="el" href="a00014.html" title="A directed or undirected graph.">graph</a> which is not biconnected.
  332. <p>
  333. If this is enabled the <a class="el" href="a00014.html" title="A directed or undirected graph.">graph</a> will be made biconnected by adding some new edges. This is usually faster than testing the biconnected <a class="el" href="a00007.html" title="Connected components algorithm.">components</a> one by one, which is done if this option is disabled. By default this is enabled.<p>
  334. <dl class="note" compact><dt><b>Note:</b></dt><dd>This is not fully tested, i.e. at the moment this feature should be used only for the test without embedding or kuratowski graphs.</dd></dl>
  335. <dl compact><dt><b>Parameters:</b></dt><dd>
  336. <table border="0" cellspacing="2" cellpadding="0">
  337. <tr><td valign="top"></td><td valign="top"><em>p</em>&nbsp;</td><td>true iff graph should be made biconnected</td></tr>
  338. </table>
  339. </dl>
  340. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00004.html#774fd08203a6d164605afc4cdc8b9201" title="If enabled edges will be added to the graph in order to make it biconnected, if cutpoints...">biconnectivity::make_biconnected</a> </dd></dl>
  341. </div>
  342. </div><p>
  343. <a class="anchor" name="ab1a8ac05bacd090cb347340e0f9d119"></a><!-- doxytag: member="planarity::make_biconnected" ref="ab1a8ac05bacd090cb347340e0f9d119" args="() const " -->
  344. <div class="memitem">
  345. <div class="memproto">
  346. <table class="memname">
  347. <tr>
  348. <td class="memname">bool planarity::make_biconnected </td>
  349. <td>(</td>
  350. <td class="paramname"> </td>
  351. <td>&nbsp;)&nbsp;</td>
  352. <td width="100%"> const<code> [inline]</code></td>
  353. </tr>
  354. </table>
  355. </div>
  356. <div class="memdoc">
  357. <p>
  358. Returns strategy for testing graphs, which are not biconnected.
  359. <p>
  360. <dl compact><dt><b>Return values:</b></dt><dd>
  361. <table border="0" cellspacing="2" cellpadding="0">
  362. <tr><td valign="top"></td><td valign="top"><em>true</em>&nbsp;</td><td>iff <a class="el" href="a00014.html" title="A directed or undirected graph.">graph</a> will be made biconnected before test</td></tr>
  363. </table>
  364. </dl>
  365. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00004.html#774fd08203a6d164605afc4cdc8b9201" title="If enabled edges will be added to the graph in order to make it biconnected, if cutpoints...">biconnectivity::make_biconnected</a> </dd></dl>
  366. </div>
  367. </div><p>
  368. <a class="anchor" name="7a623f4c0e5c753a01dab6c0a79c3b50"></a><!-- doxytag: member="planarity::is_planar" ref="7a623f4c0e5c753a01dab6c0a79c3b50" args="() const " -->
  369. <div class="memitem">
  370. <div class="memproto">
  371. <table class="memname">
  372. <tr>
  373. <td class="memname">bool planarity::is_planar </td>
  374. <td>(</td>
  375. <td class="paramname"> </td>
  376. <td>&nbsp;)&nbsp;</td>
  377. <td width="100%"> const<code> [inline]</code></td>
  378. </tr>
  379. </table>
  380. </div>
  381. <div class="memdoc">
  382. <p>
  383. Result of last test.
  384. <p>
  385. <dl compact><dt><b>Return values:</b></dt><dd>
  386. <table border="0" cellspacing="2" cellpadding="0">
  387. <tr><td valign="top"></td><td valign="top"><em>true</em>&nbsp;</td><td>iff graph in last run was planar. </td></tr>
  388. </table>
  389. </dl>
  390. </div>
  391. </div><p>
  392. <a class="anchor" name="9ab79a340e361c3300cc08e82edd4e12"></a><!-- doxytag: member="planarity::get_embedding" ref="9ab79a340e361c3300cc08e82edd4e12" args="()" -->
  393. <div class="memitem">
  394. <div class="memproto">
  395. <table class="memname">
  396. <tr>
  397. <td class="memname"><a class="el" href="a00022.html">planar_embedding</a>&amp; planarity::get_embedding </td>
  398. <td>(</td>
  399. <td class="paramname"> </td>
  400. <td>&nbsp;)&nbsp;</td>
  401. <td width="100%"><code> [inline]</code></td>
  402. </tr>
  403. </table>
  404. </div>
  405. <div class="memdoc">
  406. <p>
  407. If graph in last <a class="el" href="a00023.html#93232e765c08dd2a4c00d192bb48b5fc" title="Runs planarity test on G.">run</a> was planar a planar embedding is calculated during the reductions. This function gives access to it.
  408. <p>
  409. <dl class="return" compact><dt><b>Returns:</b></dt><dd>planar embedding of graph in last run</dd></dl>
  410. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00023.html#1679e285a7135b48b572764f5e8e773d" title="If p is true a planar embedding will be calculated in the next run.">calc_embedding</a> </dd></dl>
  411. </div>
  412. </div><p>
  413. <a class="anchor" name="c9021696934cc24afbc36aa307b2919b"></a><!-- doxytag: member="planarity::get_obstruction_edges" ref="c9021696934cc24afbc36aa307b2919b" args="()" -->
  414. <div class="memitem">
  415. <div class="memproto">
  416. <table class="memname">
  417. <tr>
  418. <td class="memname">list&lt;<a class="el" href="a00010.html">edge</a>&gt;&amp; planarity::get_obstruction_edges </td>
  419. <td>(</td>
  420. <td class="paramname"> </td>
  421. <td>&nbsp;)&nbsp;</td>
  422. <td width="100%"><code> [inline]</code></td>
  423. </tr>
  424. </table>
  425. </div>
  426. <div class="memdoc">
  427. <p>
  428. Returns the edges of a subgraph homeomorphic to either K3,3 or K5 if graph in last run was not planar.
  429. <p>
  430. <dl class="return" compact><dt><b>Returns:</b></dt><dd>edges of subgraph homeomorphic to either K3,3 or K5</dd></dl>
  431. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00023.html#c1bee50e38d398f3868a3308164caa31" title="Returns the nodes of a subgraph homeomorphic to either K3,3 or K5 if graph in last...">get_obstruction_nodes</a> <p>
  432. <a class="el" href="a00023.html#7b8e8e5414a4eedb0f99253d3b62ffa3" title="If p is true the obstructions to planarity will be calculated in the next run.">calc_obstruction</a> </dd></dl>
  433. </div>
  434. </div><p>
  435. <a class="anchor" name="c1bee50e38d398f3868a3308164caa31"></a><!-- doxytag: member="planarity::get_obstruction_nodes" ref="c1bee50e38d398f3868a3308164caa31" args="()" -->
  436. <div class="memitem">
  437. <div class="memproto">
  438. <table class="memname">
  439. <tr>
  440. <td class="memname">list&lt;<a class="el" href="a00020.html">node</a>&gt;&amp; planarity::get_obstruction_nodes </td>
  441. <td>(</td>
  442. <td class="paramname"> </td>
  443. <td>&nbsp;)&nbsp;</td>
  444. <td width="100%"><code> [inline]</code></td>
  445. </tr>
  446. </table>
  447. </div>
  448. <div class="memdoc">
  449. <p>
  450. Returns the nodes of a subgraph homeomorphic to either K3,3 or K5 if graph in last run was not planar.
  451. <p>
  452. <dl class="return" compact><dt><b>Returns:</b></dt><dd>nodes of subgraph homeomorphic to either K3,3 or K5</dd></dl>
  453. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00023.html#c9021696934cc24afbc36aa307b2919b" title="Returns the edges of a subgraph homeomorphic to either K3,3 or K5 if graph in last...">get_obstruction_edges</a> <p>
  454. <a class="el" href="a00023.html#7b8e8e5414a4eedb0f99253d3b62ffa3" title="If p is true the obstructions to planarity will be calculated in the next run.">calc_obstruction</a> </dd></dl>
  455. </div>
  456. </div><p>
  457. <p class="links">
  458. <a href="http://www.uni-passau.de/">University of Passau</a>
  459. &nbsp;-&nbsp;
  460. <a href="http://www.fmi.uni-passau.de/">FMI</a>
  461. &nbsp;-&nbsp;
  462. <a href="http://www.fmi.uni-passau.de/fmi/lehrstuehle/brandenburg/">Theoretical
  463. Computer Science</a>
  464. </p>
  465. <div class="copyright">
  466. Design &copy; 2002, 2003 <a href="mailto:raitner@fmi.uni-passau.de">Marcus Raitner</a>, University of Passau
  467. </div>
  468. </body>
  469. </html>