From 427a477645103079d00c5c608591abe6369d2e03 Mon Sep 17 00:00:00 2001 From: ducky Date: Tue, 6 Oct 2015 17:10:22 -0700 Subject: Type hierarchy diagram attempt --- doc/images/type_hierarchy.svg | 921 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 921 insertions(+) create mode 100644 doc/images/type_hierarchy.svg diff --git a/doc/images/type_hierarchy.svg b/doc/images/type_hierarchy.svg new file mode 100644 index 00000000..a8087653 --- /dev/null +++ b/doc/images/type_hierarchy.svg @@ -0,0 +1,921 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + Data + Aggregate + Element + Bundle + Vec + UInt + SInt + Bits + Bool + + + + + + + + + -- cgit v1.2.3 From 1abf1a59f363a73840dc0540ca1ae37816dc2323 Mon Sep 17 00:00:00 2001 From: ducky Date: Wed, 7 Oct 2015 12:38:05 -0700 Subject: Diagram improvements --- doc/images/type_hierarchy.svg | 215 ++++++++++++++++++++++++++---------------- 1 file changed, 132 insertions(+), 83 deletions(-) diff --git a/doc/images/type_hierarchy.svg b/doc/images/type_hierarchy.svg index a8087653..301017a5 100644 --- a/doc/images/type_hierarchy.svg +++ b/doc/images/type_hierarchy.svg @@ -11,9 +11,9 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" - width="210mm" - height="297mm" - viewBox="0 0 744.09448819 1052.3622047" + width="105.3mm" + height="95.299995mm" + viewBox="0 0 373.11022 337.67715" id="svg2" version="1.1" inkscape:version="0.91 r13725" @@ -103,61 +103,64 @@ + style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1" + d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z" + transform="scale(-0.6,-0.6)" + inkscape:connector-curvature="0" /> + d="M 0,0 5,-5 -12.5,0 5,5 0,0 Z" + style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1" + transform="matrix(-0.8,0,0,-0.8,-10,0)" + inkscape:connector-curvature="0" /> + d="M 0,0 5,-5 -12.5,0 5,5 0,0 Z" + style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1" + transform="matrix(0.8,0,0,0.8,10,0)" + inkscape:connector-curvature="0" /> + d="M 0,0 5,-5 -12.5,0 5,5 0,0 Z" + style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1" + transform="matrix(0.8,0,0,0.8,10,0)" + inkscape:connector-curvature="0" /> + gradientTransform="translate(141.73226,70.866206)" /> - - - - + + + + + + + + inkscape:object-nodes="true" + fit-margin-top="2.5" + fit-margin-left="2.5" + fit-margin-right="2.5" + fit-margin-bottom="2.5"> + id="grid3336" + originx="9.3897524" + originy="9.3897072" /> @@ -681,7 +705,8 @@ + id="layer1" + transform="translate(9.3897534,-724.07477)"> Data Data Aggregate Aggregate Element Element Bundle Bundle Bits Bits + + + + -- cgit v1.2.3 From 99a0490828d92f69d57f258ffdb335dddc7d9771 Mon Sep 17 00:00:00 2001 From: ducky Date: Wed, 7 Oct 2015 12:45:00 -0700 Subject: Link picture to README --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index c6d5f2b1..8fd52158 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,11 @@ like: - Optionally, Verilog to C++ (for simulation and testing). *TODO: Verilator support* +### Data Types Overview +These are the base data types for defining circuit wires: + +![Image](../master/docs/images/type_hierarchy.svg?raw=true) + ### Chisel Tutorial *TODO: quick howto for running chisel-tutorial* -- cgit v1.2.3 From a1561f4751361e4de7afd9a071dbec86d309455b Mon Sep 17 00:00:00 2001 From: ducky Date: Wed, 7 Oct 2015 13:05:28 -0700 Subject: Remove flowed text --- README.md | 5 +- doc/images/type_hierarchy.png | Bin 0 -> 16698 bytes doc/images/type_hierarchy.svg | 779 ++++++++++++++---------------------------- 3 files changed, 252 insertions(+), 532 deletions(-) create mode 100644 doc/images/type_hierarchy.png diff --git a/README.md b/README.md index 8fd52158..12423672 100644 --- a/README.md +++ b/README.md @@ -30,9 +30,10 @@ like: *TODO: Verilator support* ### Data Types Overview -These are the base data types for defining circuit wires: +These are the base data types for defining circuit wires (abstract types which +may not be instantiated are greyed out): -![Image](../master/docs/images/type_hierarchy.svg?raw=true) +![Image](doc/images/type_hierarchy.png?raw=true) ### Chisel Tutorial *TODO: quick howto for running chisel-tutorial* diff --git a/doc/images/type_hierarchy.png b/doc/images/type_hierarchy.png new file mode 100644 index 00000000..c808fa9d Binary files /dev/null and b/doc/images/type_hierarchy.png differ diff --git a/doc/images/type_hierarchy.svg b/doc/images/type_hierarchy.svg index 301017a5..d150cf74 100644 --- a/doc/images/type_hierarchy.svg +++ b/doc/images/type_hierarchy.svg @@ -17,72 +17,23 @@ id="svg2" version="1.1" inkscape:version="0.91 r13725" - sodipodi:docname="type_hierarchy.svg"> + sodipodi:docname="type_hierarchy.svg" + inkscape:export-filename="/home/ducky/git/chisel3/doc/images/type_hierarchy.png" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90"> - - - - - - - - - - - - - - - - - - + id="Gradient" + osb:paint="gradient"> - - + id="stop4275" /> + style="stop-color:#ffffff;stop-opacity:1" + offset="1" + id="stop4277" /> - - - - - - - - - - - - - - - - + gradientTransform="translate(141.73226,4.3895239e-5)" /> - - - - + + + - - - - - - - - - - - - - - - - + y2="958.04987" + gradientTransform="translate(-11.229986,737.74357)" /> + y2="959.86719" + gradientTransform="translate(-101.61319,-137.81993)" /> + y2="957.76147" + gradientTransform="translate(84.487714,-135.71422)" /> + y2="957.76147" + gradientTransform="translate(-139.36821,-64.848082)" /> - - - + y2="957.76147" + gradientTransform="translate(107.92521,-65.136473)" /> + + + + + + + + + - Data - Aggregate Aggregate + - Element Element + - Bundle Bundle + - Vec Vec + - UInt UInt + - SInt SInt + - Bits Bits + - Bool - - - - - - - - + x="192.06311" + y="1041.6357" + id="text5847" + sodipodi:linespacing="125%">Bool + Data -- cgit v1.2.3