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/latex/annotated.tex

35 lines
7.6 KiB
TeX
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
\section{Class List}
Analog integration part II. Analog place & route (slicing tree). * Change: In Hurricane::CellWidget, set the minimal size to 350 pixels to fit my normal DPI secondary screen... * Change: In Hurricane::Error(), reactivate the backtrace generation by default. Seriously slow down the program each time an Error is to be constructed. * Bug: In Analog::Device::preCreate(), check for NULL Technology before attempting to use it. * Change: In Hurricane/Analog, remove all '*Arguments*' classes and their Python interface. It was an obsoleted way of passing devices parameters to the Python layout generators (located in Oroshi). Now we just get them straight from the Device with the getParamter() method. * Change: In CRL::System CTOR, add Python pathes for Oroshi & Karakaze. * Change: In Oroshi/Python/WIP_*.py layout generator scripts, remove all uses of the "Arguments". Directly access the parameters through the device itself. Make the checkCoherency() with identical arguments as of layout(). * New: Bora tool that performs analog place & route. Based on a slicing tree representation. It is the thesis work of Eric Lao. Code beautyfication and some programming cleanup. * New: Karakaze tool, provide the Python base class AnalogDesign used to build an analog design. Create/configure devices and assemble them in a slicing tree. * Change: In Unicorn/cgt.py, display the stack trace in case of an ImportError exception as well as for other exceptions. Add Bora to the set for included tool engines.
2018-10-18 11:10:01 -05:00
Here are the classes, structs, unions and interfaces with brief descriptions\+:\begin{DoxyCompactList}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1AutoContact}{Auto\+Contact}} \\*Abstract base class for \mbox{\hyperlink{classKatabatic_1_1AutoContact}{Auto\+Contact}} }{\pageref{classKatabatic_1_1AutoContact}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1AutoContactHTee}{Auto\+Contact\+H\+Tee}} \\*\mbox{\hyperlink{classKatabatic_1_1AutoContact}{Auto\+Contact}} H-\/\+Tee (two H, one V) }{\pageref{classKatabatic_1_1AutoContactHTee}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1AutoContactTerminal}{Auto\+Contact\+Terminal}} \\*\mbox{\hyperlink{classKatabatic_1_1AutoContact}{Auto\+Contact}} Terminal (S/T is a Terminal) }{\pageref{classKatabatic_1_1AutoContactTerminal}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1AutoContactTurn}{Auto\+Contact\+Turn}} \\*\mbox{\hyperlink{classKatabatic_1_1AutoContact}{Auto\+Contact}} Turn (one H, one V) }{\pageref{classKatabatic_1_1AutoContactTurn}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1AutoContactVTee}{Auto\+Contact\+V\+Tee}} \\*\mbox{\hyperlink{classKatabatic_1_1AutoContact}{Auto\+Contact}} V-\/\+Tee (one H, two V) }{\pageref{classKatabatic_1_1AutoContactVTee}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1AutoHorizontal}{Auto\+Horizontal}} \\*Concrete Horizontal \mbox{\hyperlink{classKatabatic_1_1AutoSegment}{Auto\+Segment}} }{\pageref{classKatabatic_1_1AutoHorizontal}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1AutoSegment}{Auto\+Segment}} \\*Abstract base class for \mbox{\hyperlink{classKatabatic_1_1AutoSegment}{Auto\+Segment}} }{\pageref{classKatabatic_1_1AutoSegment}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1AutoSegments__Aligneds}{Auto\+Segments\+\_\+\+Aligneds}} \\*All aligned \mbox{\hyperlink{classKatabatic_1_1AutoSegment}{Auto\+Segment}} of a set }{\pageref{classKatabatic_1_1AutoSegments__Aligneds}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1AutoSegments__AnchorOnGCell}{Auto\+Segments\+\_\+\+Anchor\+On\+G\+Cell}} \\*All \mbox{\hyperlink{classKatabatic_1_1AutoSegment}{Auto\+Segment}} Beginning and/or Stopping in a \mbox{\hyperlink{classKatabatic_1_1GCell}{G\+Cell}} }{\pageref{classKatabatic_1_1AutoSegments__AnchorOnGCell}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1AutoSegments__InDirection}{Auto\+Segments\+\_\+\+In\+Direction}} \\*Filter to select \mbox{\hyperlink{classKatabatic_1_1AutoSegment}{Auto\+Segment}} in a given direction }{\pageref{classKatabatic_1_1AutoSegments__InDirection}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1AutoSegments__IsAccountable}{Auto\+Segments\+\_\+\+Is\+Accountable}} \\*Filter to select accoutable \mbox{\hyperlink{classKatabatic_1_1AutoSegment}{Auto\+Segment}} }{\pageref{classKatabatic_1_1AutoSegments__IsAccountable}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1AutoSegments__OnContact}{Auto\+Segments\+\_\+\+On\+Contact}} \\*All \mbox{\hyperlink{classKatabatic_1_1AutoSegment}{Auto\+Segment}} anchored on a Contact }{\pageref{classKatabatic_1_1AutoSegments__OnContact}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1AutoSegments__Perpandiculars}{Auto\+Segments\+\_\+\+Perpandiculars}} \\*All perpandicular \mbox{\hyperlink{classKatabatic_1_1AutoSegment}{Auto\+Segment}} to a set of aligneds }{\pageref{classKatabatic_1_1AutoSegments__Perpandiculars}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1AutoVertical}{Auto\+Vertical}} \\*Concrete Vertical \mbox{\hyperlink{classKatabatic_1_1AutoSegment}{Auto\+Segment}} }{\pageref{classKatabatic_1_1AutoVertical}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1BaseGrid_1_1Axis}{Base\+Grid\+::\+Axis}} \\*Graduations on a \mbox{\hyperlink{classKatabatic_1_1BaseGrid}{Base\+Grid}} \mbox{\hyperlink{classKatabatic_1_1BaseGrid_1_1Axis}{Axis}} (H or V) }{\pageref{classKatabatic_1_1BaseGrid_1_1Axis}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1BaseGrid}{Base\+Grid}} \\*Abstract Base Class for Irregular \mbox{\hyperlink{classKatabatic_1_1Grid}{Grid}} }{\pageref{classKatabatic_1_1BaseGrid}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1BaseObserver}{Base\+Observer}} \\*\mbox{\hyperlink{classKatabatic_1_1Observer}{Observer}} Design Pattern, \mbox{\hyperlink{classKatabatic_1_1Observer}{Observer}} part }{\pageref{classKatabatic_1_1BaseObserver}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1ChipTools}{Chip\+Tools}} \\*Utilities for Chip Level Design }{\pageref{classKatabatic_1_1ChipTools}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1GCell_1_1CompareByDensity}{G\+Cell\+::\+Compare\+By\+Density}} \\*\mbox{\hyperlink{classKatabatic_1_1GCell}{G\+Cell}} Density Comparison Functor }{\pageref{classKatabatic_1_1GCell_1_1CompareByDensity}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1GCell_1_1CompareByIndex}{G\+Cell\+::\+Compare\+By\+Index}} \\*\mbox{\hyperlink{classKatabatic_1_1GCell}{G\+Cell}} Index Comparison Functor }{\pageref{classKatabatic_1_1GCell_1_1CompareByIndex}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1GCell}{G\+Cell}} \\*Routing Global Cell }{\pageref{classKatabatic_1_1GCell}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1GCellDensitySet}{G\+Cell\+Density\+Set}} \\*\mbox{\hyperlink{classKatabatic_1_1GCell}{G\+Cell}} Set, sorted by density }{\pageref{classKatabatic_1_1GCellDensitySet}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1GCellGrid}{G\+Cell\+Grid}} \\*\mbox{\hyperlink{classKatabatic_1_1GCell}{G\+Cell}} \mbox{\hyperlink{classKatabatic_1_1Grid}{Grid}} }{\pageref{classKatabatic_1_1GCellGrid}}{}
\item\contentsline{section}{\mbox{\hyperlink{classanonymous__namespace_02LoadGrByNet_8cpp_03_1_1GCellTopology}{G\+Cell\+Topology}} \\*Build the wiring for a Net inside a G\+Cell ({\bfseries internal}) }{\pageref{classanonymous__namespace_02LoadGrByNet_8cpp_03_1_1GCellTopology}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1Grid}{Grid$<$ G\+Cell\+T $>$}} \\*Template Class for Regular \mbox{\hyperlink{classKatabatic_1_1Grid}{Grid}} }{\pageref{classKatabatic_1_1Grid}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1KatabaticEngine}{Katabatic\+Engine}} \\*The \mbox{\hyperlink{namespaceKatabatic}{Katabatic}} Tool }{\pageref{classKatabatic_1_1KatabaticEngine}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1GCell_1_1Key}{G\+Cell\+::\+Key}} \\*\mbox{\hyperlink{classKatabatic_1_1GCell}{G\+Cell}} \mbox{\hyperlink{classKatabatic_1_1GCell_1_1Key}{Key}} -\/ Density Cache }{\pageref{classKatabatic_1_1GCell_1_1Key}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1LocatorHelper}{Locator\+Helper}} \\*Locator Helper Collection\textquotesingle{}s Locators }{\pageref{classKatabatic_1_1LocatorHelper}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1Observable}{Observable}} \\*\mbox{\hyperlink{classKatabatic_1_1Observer}{Observer}} Design Pattern, Subject part }{\pageref{classKatabatic_1_1Observable}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1Observer}{Observer$<$ T $>$}} \\*\mbox{\hyperlink{classKatabatic_1_1Observer}{Observer}} Design Pattern, \mbox{\hyperlink{classKatabatic_1_1Observer}{Observer}} part }{\pageref{classKatabatic_1_1Observer}}{}
\item\contentsline{section}{\mbox{\hyperlink{classKatabatic_1_1Session}{Session}} \\*Modification \mbox{\hyperlink{classKatabatic_1_1Session}{Session}} for \mbox{\hyperlink{namespaceKatabatic}{Katabatic}} }{\pageref{classKatabatic_1_1Session}}{}
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
\end{DoxyCompactList}