riscv
/
coriolis
mirror of https://gitlab.lip6.fr/vlsi-eda/coriolis.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
coriolis/katabatic/doc/html/KatabaticEngine_8h_source.html

90 lines
72 KiB
HTML
Raw Normal View History

Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0//EN'>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Katabatic Documentation</title>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="SoC.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<h1 id="pagetop" class="header">Katabatic - Routing Toolbox</h1>
<!--
<center class="header">
<table class="header">
<tr>
<td><a href="customSummary.html">Summary</a></td>
<td><a href="namespaces.html">Namespaces</a></td>
<td><a href="customHierarchy.html">Class Hierarchy</a></td>
<td><a href="annotated.html">Classes</a></td>
<td><a href="functions.html">Member Index</a></td>
</tr>
</table>
</center>
-->
<br>
<body onload="javascript:toggleLevel(1)">
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_46a5d811a0c60e95b7acaa92d73c003a.html">katabatic</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">KatabaticEngine.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// -*- C++ -*-</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// This file is part of the Coriolis Software.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// Copyright (c) UPMC/LIP6 2008-2018, All Rights Reserved</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// +-----------------------------------------------------------------+</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// | C O R I O L I S |</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// | K a t a b a t i c - Routing Toolbox |</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// | |</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// | Author : Jean-Paul CHAPUT |</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// | E-mail : Jean-Paul.Chaput@lip6.fr |</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// | =============================================================== |</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">// | C++ Header : &quot;./katabatic/KatabaticEngine.h&quot; |</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">// +-----------------------------------------------------------------+</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#ifndef KATABATIC_KATABATIC_ENGINE_H</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#define KATABATIC_KATABATIC_ENGINE_H</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;iostream&gt;</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;set&gt;</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &lt;map&gt;</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &quot;hurricane/DbU.h&quot;</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &quot;hurricane/Torus.h&quot;</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &quot;hurricane/Layer.h&quot;</span
<div class="ttc" id="classHurricane_1_1Name_html"><div class="ttname"><a href="../hurricane/classHurricane_1_1Name.html">Hurricane::Name</a></div></div>
<div class="ttc" id="classHurricane_1_1Net_1_1Direction_html"><div class="ttname"><a href="../hurricane/classHurricane_1_1Net_1_1Direction.html">Hurricane::Net</a></div></div>
<div class="ttc" id="classHurricane_1_1Contact_html"><div class="ttname"><a href="../hurricane/classHurricane_1_1Contact.html">Hurricane::Contact</a></div></div>
<div class="ttc" id="group__DbUGroup_html_ga4fbfa3e8c89347af76c9628ea06c4146"><div class="ttname"><a href="../hurricane/group__DbUGroup.html#ga4fbfa3e8c89347af76c9628ea06c4146">Hurricane::DbU::Unit</a></div><div class="ttdeci">std::int64_t Unit</div></div>
<div class="ttc" id="classHurricane_1_1Cell_html"><div class="ttname"><a href="../hurricane/classHurricane_1_1Cell.html">Hurricane::Cell</a></div></div>
<div class="ttc" id="classCRL_1_1RoutingGauge_html"><div class="ttname"><a href="../crlcore/classCRL_1_1RoutingGauge.html">CRL::RoutingGauge</a></div></div>
<div class="ttc" id="classHurricane_1_1Layer_html_af5277c670637bd5d910237e7afe01a91"><div class="ttname"><a href="../hurricane/classHurricane_1_1Layer.html#af5277c670637bd5d910237e7afe01a91">Hurricane::Layer::Mask</a></div><div class="ttdeci">Hurricane::Mask&lt; unsigned long long &gt; Mask</div></div>
<div class="ttc" id="classKatabatic_1_1GCellGrid_html"><div class="ttname"><a href="classKatabatic_1_1GCellGrid.html">Katabatic::GCellGrid</a></div><div class="ttdoc">GCell Grid. </div><div class="ttdef"><b>Definition:</b> GCellGrid.h:42</div></div>
<div class="ttc" id="classKatabatic_1_1AutoSegment_html"><div class="ttname"><a href="classKatabatic_1_1AutoSegment.html">Katabatic::AutoSegment</a></div><div class="ttdoc">Abstract base class for AutoSegment. </div><div class="ttdef"><b>Definition:</b> AutoSegment.h:104</div></div>
<div class="ttc" id="classHurricane_1_1GenericCollection_html"><div class="ttname"><a href="../hurricane/classHurricane_1_1GenericCollection.html">Hurricane::GenericCollection</a></div></div>
<div class="ttc" id="classKatabatic_1_1GCell_html_aacb1c215b203bfba5729f135b3221d40"><div class="ttname"><a href="classKatabatic_1_1GCell.html#aacb1c215b203bfba5729f135b3221d40">Katabatic::GCell::SetIndex</a></div><div class="ttdeci">set&lt; GCell *, CompareByIndex &gt; SetIndex</div><div class="ttdef"><b>Definition:</b> GCell.h:105</div></div>
<div class="ttc" id="namespaceKatabatic_html"><div class="ttname"><a href="namespaceKatabatic.html">Katabatic</a></div><div class="ttdoc">The namespace dedicated to Katabatic. </div><div class="ttdef"><b>Definition:</b> Katabatic.dox:13</div></div>
<div class="ttc" id="classHurricane_1_1Box_html"><div class="ttname"><a href="../hurricane/classHurricane_1_1Box.html">Hurricane::Box</a></div></div>
<div class="ttc" id="classKatabatic_1_1KatabaticEngine_html"><div class="ttname"><a href="classKatabatic_1_1KatabaticEngine.html">Katabatic::KatabaticEngine</a></div><div class="ttdoc">The Katabatic Tool. </div><div class="ttdef"><b>Definition:</b> KatabaticEngine.h:91</div></div>
<div class="ttc" id="classHurricane_1_1Instance_html"><div class="ttname"><a href="../hurricane/classHurricane_1_1Instance.html">Hurricane::Instance</a></div></div>
<div class="ttc" id="classCRL_1_1ToolEngine_html"><div class="ttname"><a href="../crlcore/classCRL_1_1ToolEngine.html">CRL::ToolEngine</a></div></div>
<div class="ttc" id="classHurricane_1_1Layer_html"><div class="ttname"><a href="../hurricane/classHurricane_1_1Layer.html">Hurricane::Layer</a></div></div>
<div class="ttc" id="classHurricane_1_1Segment_html"><div class="ttname"><a href="../hurricane/classHurricane_1_1Segment.html">Hurricane::Segment</a></div></div>
<div class="ttc" id="classKatabatic_1_1ChipTools_html"><div class="ttname"><a href="classKatabatic_1_1ChipTools.html">Katabatic::ChipTools</a></div><div class="ttdoc">Utilities for Chip Level Design. </div><div class="ttdef"><b>Definition:</b> ChipTools.h:39</div></div>
<div class="ttc" id="namespaceKatabatic_html_ab9e409db5feff0bdbc85e90e2a029cdaafb5f961d4cad2bb9fbda71204061c877"><div class="ttname"><a href="namespaceKatabatic.html#ab9e409db5feff0bdbc85e90e2a029cdaafb5f961d4cad2bb9fbda71204061c877">Katabatic::EngineGutted</a></div><div class="ttdef"><b>Definition:</b> Constants.h:59</div></div>
<div class="ttc" id="namespaceHurricane_html"><div class="ttname"><a href="namespaceHurricane.html">Hurricane</a></div></div>
<div class="ttc" id="classKatabatic_1_1AutoContact_html"><div class="ttname"><a href="classKatabatic_1_1AutoContact.html">Katabatic::AutoContact</a></div><div class="ttdoc">Abstract base class for AutoContact. </div><div class="ttdef"><b>Definition:</b> AutoContact.h:70</div></div>
<div class="ttc" id="classHurricane_1_1Net_html"><div class="ttname"><a href="../hurricane/classHurricane_1_1Net.html">Hurricane::Net</a></div></div>
<div class="ttc" id="namespaceKatabatic_html_ab9e409db5feff0bdbc85e90e2a029cda"><div class="ttname"><a href="namespaceKatabatic.html#ab9e409db5feff0bdbc85e90e2a029cda">Katabatic::EngineState</a></div><div class="ttdeci">EngineState</div><div class="ttdef"><b>Definition:</b> Constants.h:54</div></div>
<div class="ttc" id="classCRL_1_1RoutingLayerGauge_html"><div class="ttname"><a href="../crlcore/classCRL_1_1RoutingLayerGauge.html">CRL::RoutingLayerGauge</a></div></div>
<div class="ttc" id="namespaceCRL_html"><div class="ttname"><a href="namespaceCRL.html">CRL</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<br>
<hr>
<table class="footer1">
<tr>
<td class="LFooter"><small>Generated by doxygen 1.8.13 on Mon May 14 2018</small></td>
<td class="RFooter"><a href='#pagetop'><small>Return to top of page</small></a></td>
</tr>
</table>
<table class="footer2">
<tr>
<td class="LFooter">Katabatic - Routing Toolbox</td>
<td class="RFooter"><small>Copyright &#169; 2008-2016 UPMC. All rights reserved</small></td>
</tr>
</table>
</body>
</html>