From ff9b8bb838ecdfbfc1dc81038fcf3b2a87636982 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Cl=C3=A9ment=20Zrounba?=
 <6691770+clement-z@users.noreply.github.com>
Date: Sat, 30 Sep 2023 23:06:01 +0200
Subject: Initial release

---
 doc/resources/cheatsheet.pdf    | Bin 0 -> 71515 bytes
 doc/resources/delayedwriter.svg |  39 +++++++++++++++++++++++++++++++++++++++
 doc/resources/gdrsoc_poster.pdf | Bin 0 -> 1114814 bytes
 doc/resources/signals.svg       |  35 +++++++++++++++++++++++++++++++++++
 4 files changed, 74 insertions(+)
 create mode 100644 doc/resources/cheatsheet.pdf
 create mode 100644 doc/resources/delayedwriter.svg
 create mode 100644 doc/resources/gdrsoc_poster.pdf
 create mode 100644 doc/resources/signals.svg

(limited to 'doc/resources')

diff --git a/doc/resources/cheatsheet.pdf b/doc/resources/cheatsheet.pdf
new file mode 100644
index 0000000..8e2bf3a
Binary files /dev/null and b/doc/resources/cheatsheet.pdf differ
diff --git a/doc/resources/delayedwriter.svg b/doc/resources/delayedwriter.svg
new file mode 100644
index 0000000..996c26b
--- /dev/null
+++ b/doc/resources/delayedwriter.svg
@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentScriptType="application/ecmascript" contentStyleType="text/css" height="325px" preserveAspectRatio="none" style="width:291px;height:325px;" version="1.1" viewBox="0 0 291 325" width="291px" zoomAndPan="magnify"><defs><filter height="300%" id="fj3cfvzyv2q3n" width="300%" x="-1" y="-1"><feGaussianBlur result="blurOut" stdDeviation="2.0"/><feColorMatrix in="blurOut" result="blurOut2" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 .4 0"/><feOffset dx="4.0" dy="4.0" in="blurOut2" result="blurOut3"/><feBlend in="SourceGraphic" in2="blurOut3" mode="normal"/></filter></defs><g><!--class DelayedWriter--><rect fill="#FEFECE" filter="url(#fj3cfvzyv2q3n)" height="306.4844" id="DelayedWriter" style="stroke: #A80036; stroke-width: 1.5;" width="271" x="6" y="8"/><ellipse cx="71.25" cy="24" fill="#ADD1B2" rx="11" ry="11" style="stroke: #A80036; stroke-width: 1.0;"/><path d="M74.2188,29.6406 Q73.6406,29.9375 73,30.0781 Q72.3594,30.2344 71.6563,30.2344 Q69.1563,30.2344 67.8281,28.5938 Q66.5156,26.9375 66.5156,23.8125 Q66.5156,20.6875 67.8281,19.0313 Q69.1563,17.375 71.6563,17.375 Q72.3594,17.375 73,17.5313 Q73.6563,17.6875 74.2188,17.9844 L74.2188,20.7031 Q73.5938,20.125 73,19.8594 Q72.4063,19.5781 71.7813,19.5781 Q70.4375,19.5781 69.75,20.6563 Q69.0625,21.7188 69.0625,23.8125 Q69.0625,25.9063 69.75,26.9844 Q70.4375,28.0469 71.7813,28.0469 Q72.4063,28.0469 73,27.7813 Q73.5938,27.5 74.2188,26.9219 L74.2188,29.6406 Z "/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="87" x="91.75" y="28.1543">DelayedWriter</text><rect fill="#FFFFFF" height="15.9688" style="stroke: #000000; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" width="43" x="237" y="5"/><text fill="#000000" font-family="sans-serif" font-size="12" font-style="italic" lengthAdjust="spacingAndGlyphs" textLength="41" x="238" y="17.1387">class T</text><line style="stroke: #A80036; stroke-width: 1.5;" x1="7" x2="276" y1="40" y2="40"/><polygon fill="none" points="17,64.707,13,70.707,21,70.707" style="stroke: #1963A0; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="245" x="26" y="71.0151">port_type = sc_port&lt;sc_signal_out_if&lt;T&gt;&gt;</text><polygon fill="none" points="17,77.5117,13,83.5117,21,83.5117" style="stroke: #1963A0; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="194" x="26" y="83.8198">pair_type = std::pair&lt;sc_time, T&gt;</text><polygon fill="none" points="17,90.3164,13,96.3164,21,96.3164" style="stroke: #1963A0; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="213" x="26" y="96.6245">queue_type = std::deque&lt;pair_type&gt;</text><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 1.0,2.0;" x1="7" x2="102.5" y1="54.4023" y2="54.4023"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="78" x="102.5" y="57.7104">internal types</text><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 1.0,2.0;" x1="180.5" x2="276" y1="54.4023" y2="54.4023"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="7" x2="276" y1="103.2188" y2="103.2188"/><polygon fill="none" points="17,110.1211,21,114.1211,17,118.1211,13,114.1211" style="stroke: #B38D22; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="98" x="26" y="117.4292">port : port_type&amp;</text><ellipse cx="17" cy="127.9258" fill="none" rx="3" ry="3" style="stroke: #038048; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="64" x="26" y="130.2339">curr_val : T</text><ellipse cx="17" cy="140.7305" fill="none" rx="3" ry="3" style="stroke: #038048; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="112" x="26" y="143.0386">queue : queue_type</text><rect fill="none" height="6" style="stroke: #C82930; stroke-width: 1.0;" width="6" x="14" y="150.5352"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="175" x="26" y="155.8433">event_queue : sc_event_queue</text><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 1.0,2.0;" x1="7" x2="276" y1="162.4375" y2="162.4375"/><ellipse cx="17" cy="174.3398" fill="none" rx="3" ry="3" style="stroke: #038048; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="137" x="26" y="176.6479">actAsAccumulator : bool</text><ellipse cx="17" cy="187.1445" fill="none" rx="3" ry="3" style="stroke: #038048; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="77" x="26" y="189.4526">acc_val : bool</text><line style="stroke: #A80036; stroke-width: 1.0;" x1="7" x2="276" y1="196.0469" y2="196.0469"/><rect fill="#F24D5C" height="6" style="stroke: #C82930; stroke-width: 1.0;" width="6" x="14" y="204.9492"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="126" x="26" y="210.2573">on_data_ready() : void</text><ellipse cx="17" cy="220.7539" fill="#84BE84" rx="3" ry="3" style="stroke: #038048; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="174" x="26" y="223.062">delayedWrite(T, sc_time) : void</text><ellipse cx="17" cy="233.5586" fill="#84BE84" rx="3" ry="3" style="stroke: #038048; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="122" x="26" y="235.8667">writeNow_nb(T) : void</text><ellipse cx="17" cy="246.3633" fill="#84BE84" rx="3" ry="3" style="stroke: #038048; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="102" x="26" y="248.6714">writeNow(T) : void</text><ellipse cx="17" cy="259.168" fill="#84BE84" rx="3" ry="3" style="stroke: #038048; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="119" x="26" y="261.4761">getCurrentValue() : T</text><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 1.0,2.0;" x1="7" x2="276" y1="268.0703" y2="268.0703"/><ellipse cx="17" cy="279.9727" fill="#84BE84" rx="3" ry="3" style="stroke: #038048; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="144" x="26" y="282.2808">actAsAccumulator() : void</text><ellipse cx="17" cy="292.7773" fill="#84BE84" rx="3" ry="3" style="stroke: #038048; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="99" x="26" y="295.0854">resetAcc(T) : void</text><ellipse cx="17" cy="305.582" fill="#84BE84" rx="3" ry="3" style="stroke: #038048; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="95" x="26" y="307.8901">getAccValue() : T</text><!--
+@startuml delayedwriter
+class DelayedWriter <class T> {
+    ..internal types..
+    ~port_type = sc_port<sc_signal_out_if<T>>
+    ~pair_type = std::pair<sc_time, T>
+    ~queue_type = std::deque<pair_type>
+    - -
+    #port : port_type&
+    +curr_val : T
+    +queue : queue_type
+    -event_queue : sc_event_queue
+    ..
+    +actAsAccumulator : bool
+    +acc_val : bool
+    - -
+    -on_data_ready() : void
+    +delayedWrite(T, sc_time) : void
+    +writeNow_nb(T) : void
+    +writeNow(T) : void
+    +getCurrentValue() : T
+    ..
+    +actAsAccumulator() : void
+    +resetAcc(T) : void
+    +getAccValue() : T
+}
+@enduml
+
+PlantUML version 1.2018.01(Sun Jan 28 19:08:22 CET 2018)
+(GPL source distribution)
+Java Runtime: OpenJDK Runtime Environment
+JVM: OpenJDK 64-Bit Server VM
+Java Version: 13.0.1+9
+Operating System: Linux
+OS Version: 4.19.95-1-lts
+Default Encoding: UTF-8
+Language: en
+Country: US
+--></g></svg>
\ No newline at end of file
diff --git a/doc/resources/gdrsoc_poster.pdf b/doc/resources/gdrsoc_poster.pdf
new file mode 100644
index 0000000..e71c200
Binary files /dev/null and b/doc/resources/gdrsoc_poster.pdf differ
diff --git a/doc/resources/signals.svg b/doc/resources/signals.svg
new file mode 100644
index 0000000..3671d35
--- /dev/null
+++ b/doc/resources/signals.svg
@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentScriptType="application/ecmascript" contentStyleType="text/css" height="212px" preserveAspectRatio="none" style="width:479px;height:212px;" version="1.1" viewBox="0 0 479 212" width="479px" zoomAndPan="magnify"><defs><filter height="300%" id="f1ah9w5ca8awd5" width="300%" x="-1" y="-1"><feGaussianBlur result="blurOut" stdDeviation="2.0"/><feColorMatrix in="blurOut" result="blurOut2" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 .4 0"/><feOffset dx="4.0" dy="4.0" in="blurOut2" result="blurOut3"/><feBlend in="SourceGraphic" in2="blurOut3" mode="normal"/></filter></defs><g><!--cluster Signals--><polygon fill="#FFFFFF" filter="url(#f1ah9w5ca8awd5)" points="22,24,84,24,91,46.2969,457,46.2969,457,200,22,200,22,24" style="stroke: #000000; stroke-width: 1.5;"/><line style="stroke: #000000; stroke-width: 1.5;" x1="22" x2="91" y1="46.2969" y2="46.2969"/><text fill="#000000" font-family="sans-serif" font-size="14" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="56" x="26" y="38.9951">Signals</text><!--class OpticalSignal::Type--><rect fill="#FEFECE" filter="url(#f1ah9w5ca8awd5)" height="99.2188" id="OpticalSignal::Type" style="stroke: #A80036; stroke-width: 1.5;" width="150" x="38" y="72"/><ellipse cx="53" cy="88" fill="#EB937F" rx="11" ry="11" style="stroke: #A80036; stroke-width: 1.0;"/><path d="M57.1094,94 L49.3906,94 L49.3906,81.6094 L57.1094,81.6094 L57.1094,83.7656 L51.8438,83.7656 L51.8438,86.4375 L56.6094,86.4375 L56.6094,88.5938 L51.8438,88.5938 L51.8438,91.8438 L57.1094,91.8438 L57.1094,94 Z "/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="118" x="67" y="92.1543">OpticalSignal::Type</text><line style="stroke: #A80036; stroke-width: 1.5;" x1="39" x2="187" y1="104" y2="104"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="32" x="44" y="118.2104">NONE</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="33" x="44" y="131.0151">WRITE</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="36" x="44" y="143.8198">ERASE</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="53" x="44" y="156.6245">READOUT</text><line style="stroke: #A80036; stroke-width: 1.5;" x1="39" x2="187" y1="163.2188" y2="163.2188"/><!--class OpticalSignal--><rect fill="#FEFECE" filter="url(#f1ah9w5ca8awd5)" height="124.8281" id="OpticalSignal" style="stroke: #A80036; stroke-width: 1.5;" width="218" x="223" y="59"/><ellipse cx="287.25" cy="75" fill="#ADD1B2" rx="11" ry="11" style="stroke: #A80036; stroke-width: 1.0;"/><path d="M290.2188,80.6406 Q289.6406,80.9375 289,81.0781 Q288.3594,81.2344 287.6563,81.2344 Q285.1563,81.2344 283.8281,79.5938 Q282.5156,77.9375 282.5156,74.8125 Q282.5156,71.6875 283.8281,70.0313 Q285.1563,68.375 287.6563,68.375 Q288.3594,68.375 289,68.5313 Q289.6563,68.6875 290.2188,68.9844 L290.2188,71.7031 Q289.5938,71.125 289,70.8594 Q288.4063,70.5781 287.7813,70.5781 Q286.4375,70.5781 285.75,71.6563 Q285.0625,72.7188 285.0625,74.8125 Q285.0625,76.9063 285.75,77.9844 Q286.4375,79.0469 287.7813,79.0469 Q288.4063,79.0469 289,78.7813 Q289.5938,78.5 290.2188,77.9219 L290.2188,80.6406 Z "/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="81" x="307.75" y="79.1543">OpticalSignal</text><line style="stroke: #A80036; stroke-width: 1.5;" x1="224" x2="440" y1="91" y2="91"/><ellipse cx="234" cy="102.9023" fill="none" rx="3" ry="3" style="stroke: #038048; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="36" x="243" y="105.2104">id : int</text><ellipse cx="234" cy="115.707" fill="none" rx="3" ry="3" style="stroke: #038048; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="63" x="243" y="118.0151">type : Type</text><ellipse cx="234" cy="128.5117" fill="none" rx="3" ry="3" style="stroke: #038048; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="192" x="243" y="130.8198">parameter : union{double, void*}</text><ellipse cx="234" cy="141.3164" fill="none" rx="3" ry="3" style="stroke: #038048; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="114" x="243" y="143.6245">wavelength : double</text><line style="stroke: #A80036; stroke-width: 1.0;" x1="224" x2="440" y1="150.2188" y2="150.2188"/><ellipse cx="234" cy="162.1211" fill="#84BE84" rx="3" ry="3" style="stroke: #038048; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="86" x="243" y="164.4292">getNewId() : int</text><ellipse cx="234" cy="174.9258" fill="#84BE84" rx="3" ry="3" style="stroke: #038048; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="135" x="243" y="177.2339">attenuate(double) : void</text><!--link OpticalSignal::Type to OpticalSignal--><path d="M203.39,121.5 C209.86,121.5 216.33,121.5 222.81,121.5 " fill="none" id="OpticalSignal::Type-OpticalSignal" style="stroke: #A80036; stroke-width: 1.0;"/><ellipse cx="196.28" cy="121.5" fill="#FFFFFF" rx="8" ry="8" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="204.28" x2="188.28" y1="121.5" y2="121.5"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="196.28" x2="196.28" y1="129.5" y2="113.5"/><!--
+@startuml signals
+package Signals {
+
+    enum OpticalSignal::Type {
+        NONE
+        WRITE
+        ERASE
+        READOUT
+    }
+
+    class OpticalSignal {
+        + id : int
+        + type : Type
+        + parameter : union{double, void*}
+        + wavelength : double
+        - -
+        + getNewId() : int
+        + attenuate(double) : void
+    }
+    OpticalSignal::Type +- OpticalSignal
+}
+@enduml
+
+PlantUML version 1.2018.01(Sun Jan 28 19:08:22 CET 2018)
+(GPL source distribution)
+Java Runtime: OpenJDK Runtime Environment
+JVM: OpenJDK 64-Bit Server VM
+Java Version: 13.0.1+9
+Operating System: Linux
+OS Version: 4.19.95-1-lts
+Default Encoding: UTF-8
+Language: en
+Country: US
+--></g></svg>
\ No newline at end of file
-- 
cgit v1.2.3