tboudreaux/stroid
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(docs): updated docs for version v0.2.0

Browse Source
This commit is contained in:
Emily Boudreaux
2026-03-20 13:02:09 -04:00
parent 4a692c08f4
commit b00a64309b
70 changed files with 551 additions and 223 deletions
Download Patch File Download Diff File Expand all files Collapse all files

145
docs/html/curvilinear_8cpp__incl.svg
View File

@@ -1,13 +1,12 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 13.0.1 (20250615.1724)
<!-- Generated by graphviz version 14.1.2 (20260124.0452)
-->
<!-- Title: src/lib/topology/curvilinear.cpp Pages: 1 -->
<svg width="431pt" height="138pt"
viewBox="0.00 0.00 431.00 138.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<!--zoomable 138 -->
<svg id="main" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve">
<svg id="main" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" onload="init(evt)">
<style type="text/css"><![CDATA[
.node, .edge {opacity: 0.7;}
@@ -15,16 +14,53 @@
.edge:hover path { stroke: red; }
.edge:hover polygon { stroke: red; fill: red; }
]]></style>
<defs>
<circle id="rim" cx="0" cy="0" r="7"/>
<circle id="rim2" cx="0" cy="0" r="3.5"/>
<g id="zoomPlus">
<use xlink:href="#rim" fill="#404040"><set attributeName="fill" to="#808080" begin="zoomplus.mouseover" end="zoomplus.mouseout"/></use>
<path d="M-4,0h8M0,-4v8" fill="none" stroke="white" stroke-width="1.5" pointer-events="none"/>
</g>
<g id="zoomMin">
<use xlink:href="#rim" fill="#404040"><set attributeName="fill" to="#808080" begin="zoomminus.mouseover" end="zoomminus.mouseout"/></use>
<path d="M-4,0h8" fill="none" stroke="white" stroke-width="1.5" pointer-events="none"/>
</g>
<g id="arrowUp" transform="translate(30 24)">
<use xlink:href="#rim"/>
<path pointer-events="none" fill="none" stroke="white" stroke-width="1.5" d="M0,-3.0v7 M-2.5,-0.5L0,-3.0L2.5,-0.5"/>
</g>
<g id="arrowRight" transform="rotate(90) translate(36 -43)">
<use xlink:href="#rim"/>
<path pointer-events="none" fill="none" stroke="white" stroke-width="1.5" d="M0,-3.0v7 M-2.5,-0.5L0,-3.0L2.5,-0.5"/>
</g>
<g id="arrowDown" transform="rotate(180) translate(-30 -48)">
<use xlink:href="#rim"/>
<path pointer-events="none" fill="none" stroke="white" stroke-width="1.5" d="M0,-3.0v7 M-2.5,-0.5L0,-3.0L2.5,-0.5"/>
</g>
<g id="arrowLeft" transform="rotate(270) translate(-36 17)">
<use xlink:href="#rim"/>
<path pointer-events="none" fill="none" stroke="white" stroke-width="1.5" d="M0,-3.0v7 M-2.5,-0.5L0,-3.0L2.5,-0.5"/>
</g>
<g id="resetDef">
<use xlink:href="#rim2" fill="#404040"><set attributeName="fill" to="#808080" begin="reset.mouseover" end="reset.mouseout"/></use>
</g>
</defs>
<script type="application/ecmascript">
var viewWidth = 515;
var viewHeight = 138;
var sectionId = 'dynsection-0';
</script>
<script type="application/ecmascript" xlink:href="svg.min.js"/>
<svg id="graph" class="graph">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 133.75)">
<g id="viewport">
<title>src/lib/topology/curvilinear.cpp</title>
<!-- Node1 -->
<g id="Node000001" class="node">
<title>Node1</title>
<g id="a_Node000001"><a xlink:title=" ">
<polygon fill="#999999" stroke="#666666" points="346.38,-129.75 199.12,-129.75 199.12,-110.5 346.38,-110.5 346.38,-129.75"/>
<text xml:space="preserve" text-anchor="middle" x="272.75" y="-116.25" font-family="Helvetica,sans-Serif" font-size="10.00">src/lib/topology/curvilinear.cpp</text>
<polygon fill="#999999" stroke="#666666" points="404.38,-129.75 257.12,-129.75 257.12,-110.5 404.38,-110.5 404.38,-129.75"/>
<text xml:space="preserve" text-anchor="middle" x="330.75" y="-116.25" font-family="Helvetica,sans-Serif" font-size="10.00">src/lib/topology/curvilinear.cpp</text>
</a>
</g>
</g>
@@ -32,8 +68,8 @@
<g id="Node000002" class="node">
<title>Node2</title>
<g id="a_Node000002"><a xlink:href="curvilinear_8h.html" target="_top" xlink:title=" ">
<polygon fill="white" stroke="#666666" points="137,-74.5 2.5,-74.5 2.5,-55.25 137,-55.25 137,-74.5"/>
<text xml:space="preserve" text-anchor="middle" x="69.75" y="-61" font-family="Helvetica,sans-Serif" font-size="10.00">stroid/topology/curvilinear.h</text>
<polygon fill="white" stroke="#666666" points="286,-74.5 151.5,-74.5 151.5,-55.25 286,-55.25 286,-74.5"/>
<text xml:space="preserve" text-anchor="middle" x="218.75" y="-61" font-family="Helvetica,sans-Serif" font-size="10.00">stroid/topology/curvilinear.h</text>
</a>
</g>
</g>
@@ -41,8 +77,8 @@
<g id="edge1_Node000001_Node000002" class="edge">
<title>Node1&#45;&gt;Node2</title>
<g id="a_edge1_Node000001_Node000002"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M238.31,-110.09C204.48,-101.22 152.66,-87.62 115.41,-77.85"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="116.38,-74.49 105.82,-75.34 114.6,-81.26 116.38,-74.49"/>
<path fill="none" stroke="#63b8ff" d="M311.75,-110.09C294.29,-101.79 268.15,-89.36 248.03,-79.79"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="249.74,-76.74 239.21,-75.6 246.74,-83.06 249.74,-76.74"/>
</a>
</g>
</g>
@@ -50,8 +86,8 @@
<g id="Node000006" class="node">
<title>Node6</title>
<g id="a_Node000006"><a xlink:href="mapping_8h.html" target="_top" xlink:title=" ">
<polygon fill="white" stroke="#666666" points="282.62,-74.5 154.88,-74.5 154.88,-55.25 282.62,-55.25 282.62,-74.5"/>
<text xml:space="preserve" text-anchor="middle" x="218.75" y="-61" font-family="Helvetica,sans-Serif" font-size="10.00">stroid/topology/mapping.h</text>
<polygon fill="white" stroke="#666666" points="133.62,-74.5 5.88,-74.5 5.88,-55.25 133.62,-55.25 133.62,-74.5"/>
<text xml:space="preserve" text-anchor="middle" x="69.75" y="-61" font-family="Helvetica,sans-Serif" font-size="10.00">stroid/topology/mapping.h</text>
</a>
</g>
</g>
@@ -59,8 +95,8 @@
<g id="edge5_Node000001_Node000006" class="edge">
<title>Node1&#45;&gt;Node6</title>
<g id="a_edge5_Node000001_Node000006"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M263.83,-110.33C256.3,-102.9 245.28,-92.04 236.02,-82.91"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="238.52,-80.45 228.94,-75.92 233.6,-85.44 238.52,-80.45"/>
<path fill="none" stroke="#63b8ff" d="M286.18,-110.03C241.7,-100.96 173.24,-86.99 125.26,-77.2"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="126.12,-73.8 115.62,-75.23 124.72,-80.66 126.12,-73.8"/>
</a>
</g>
</g>
@@ -68,8 +104,8 @@
<g id="Node000007" class="node">
<title>Node7</title>
<g id="a_Node000007"><a xlink:title=" ">
<polygon fill="#e0e0e0" stroke="#999999" points="354.5,-74.5 301,-74.5 301,-55.25 354.5,-55.25 354.5,-74.5"/>
<text xml:space="preserve" text-anchor="middle" x="327.75" y="-61" font-family="Helvetica,sans-Serif" font-size="10.00">iostream</text>
<polygon fill="#e0e0e0" stroke="#999999" points="357.5,-74.5 304,-74.5 304,-55.25 357.5,-55.25 357.5,-74.5"/>
<text xml:space="preserve" text-anchor="middle" x="330.75" y="-61" font-family="Helvetica,sans-Serif" font-size="10.00">iostream</text>
</a>
</g>
</g>
@@ -77,8 +113,8 @@
<g id="edge9_Node000001_Node000007" class="edge">
<title>Node1&#45;&gt;Node7</title>
<g id="a_edge9_Node000001_Node000007"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M281.83,-110.33C289.59,-102.82 300.96,-91.81 310.45,-82.63"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="312.63,-85.38 317.38,-75.91 307.76,-80.35 312.63,-85.38"/>
<path fill="none" stroke="#63b8ff" d="M330.75,-110.33C330.75,-103.82 330.75,-94.67 330.75,-86.37"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="334.25,-86.37 330.75,-76.37 327.25,-86.37 334.25,-86.37"/>
</a>
</g>
</g>
@@ -86,8 +122,8 @@
<g id="Node000008" class="node">
<title>Node8</title>
<g id="a_Node000008"><a xlink:title=" ">
<polygon fill="#e0e0e0" stroke="#999999" points="423.38,-74.5 372.12,-74.5 372.12,-55.25 423.38,-55.25 423.38,-74.5"/>
<text xml:space="preserve" text-anchor="middle" x="397.75" y="-61" font-family="Helvetica,sans-Serif" font-size="10.00">memory</text>
<polygon fill="#e0e0e0" stroke="#999999" points="426.38,-74.5 375.12,-74.5 375.12,-55.25 426.38,-55.25 426.38,-74.5"/>
<text xml:space="preserve" text-anchor="middle" x="400.75" y="-61" font-family="Helvetica,sans-Serif" font-size="10.00">memory</text>
</a>
</g>
</g>
@@ -95,8 +131,26 @@
<g id="edge10_Node000001_Node000008" class="edge">
<title>Node1&#45;&gt;Node8</title>
<g id="a_edge10_Node000001_Node000008"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M293.95,-110.09C313.71,-101.68 343.42,-89.02 366,-79.4"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="367.22,-82.68 375.05,-75.55 364.48,-76.24 367.22,-82.68"/>
<path fill="none" stroke="#63b8ff" d="M342.62,-110.09C352.84,-102.32 367.82,-90.92 380.01,-81.65"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="382.01,-84.53 387.85,-75.69 377.77,-78.96 382.01,-84.53"/>
</a>
</g>
</g>
<!-- Node9 -->
<g id="Node000009" class="node">
<title>Node9</title>
<g id="a_Node000009"><a xlink:title=" ">
<polygon fill="#e0e0e0" stroke="#999999" points="506.62,-74.5 444.88,-74.5 444.88,-55.25 506.62,-55.25 506.62,-74.5"/>
<text xml:space="preserve" text-anchor="middle" x="475.75" y="-61" font-family="Helvetica,sans-Serif" font-size="10.00">sys/proc.h</text>
</a>
</g>
</g>
<!-- Node1&#45;&gt;Node9 -->
<g id="edge11_Node000001_Node000009" class="edge">
<title>Node1&#45;&gt;Node9</title>
<g id="a_edge11_Node000001_Node000009"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M355.35,-110.09C378.68,-101.52 413.99,-88.56 440.35,-78.88"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="441.43,-82.21 449.61,-75.47 439.02,-75.64 441.43,-82.21"/>
</a>
</g>
</g>
@@ -113,8 +167,8 @@
<g id="edge2_Node000002_Node000003" class="edge">
<title>Node2&#45;&gt;Node3</title>
<g id="a_edge2_Node000002_Node000003"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M63.14,-55.08C57.79,-47.96 50.07,-37.68 43.4,-28.8"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="46.21,-26.71 37.41,-20.82 40.62,-30.92 46.21,-26.71"/>
<path fill="none" stroke="#63b8ff" d="M186.69,-54.84C154.66,-45.82 105.32,-31.92 70.53,-22.11"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="71.81,-18.84 61.24,-19.5 69.91,-25.58 71.81,-18.84"/>
</a>
</g>
</g>
@@ -131,8 +185,8 @@
<g id="edge3_Node000002_Node000004" class="edge">
<title>Node2&#45;&gt;Node4</title>
<g id="a_edge3_Node000002_Node000004"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M80.1,-54.84C88.83,-47.22 101.54,-36.12 112.05,-26.95"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="114.18,-29.73 119.41,-20.52 109.58,-24.46 114.18,-29.73"/>
<path fill="none" stroke="#63b8ff" d="M203.82,-54.84C190.55,-46.81 170.88,-34.91 155.3,-25.48"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="157.41,-22.67 147.05,-20.49 153.79,-28.66 157.41,-22.67"/>
</a>
</g>
</g>
@@ -149,8 +203,8 @@
<g id="edge4_Node000002_Node000005" class="edge">
<title>Node2&#45;&gt;Node5</title>
<g id="a_edge4_Node000002_Node000005"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M101.81,-54.84C133.17,-46.01 181.14,-32.49 215.79,-22.73"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="216.4,-26.19 225.07,-20.11 214.5,-19.46 216.4,-26.19"/>
<path fill="none" stroke="#63b8ff" d="M225.36,-55.08C230.71,-47.96 238.43,-37.68 245.1,-28.8"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="247.88,-30.92 251.09,-20.82 242.29,-26.71 247.88,-30.92"/>
</a>
</g>
</g>
@@ -158,8 +212,8 @@
<g id="edge6_Node000006_Node000003" class="edge">
<title>Node6&#45;&gt;Node3</title>
<g id="a_edge6_Node000006_Node000003"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M186.69,-54.84C154.66,-45.82 105.32,-31.92 70.53,-22.11"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="71.81,-18.84 61.24,-19.5 69.91,-25.58 71.81,-18.84"/>
<path fill="none" stroke="#63b8ff" d="M63.14,-55.08C57.79,-47.96 50.07,-37.68 43.4,-28.8"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="46.21,-26.71 37.41,-20.82 40.62,-30.92 46.21,-26.71"/>
</a>
</g>
</g>
@@ -167,8 +221,8 @@
<g id="edge7_Node000006_Node000004" class="edge">
<title>Node6&#45;&gt;Node4</title>
<g id="a_edge7_Node000006_Node000004"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M203.82,-54.84C190.55,-46.81 170.88,-34.91 155.3,-25.48"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="157.41,-22.67 147.05,-20.49 153.79,-28.66 157.41,-22.67"/>
<path fill="none" stroke="#63b8ff" d="M80.1,-54.84C88.83,-47.22 101.54,-36.12 112.05,-26.95"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="114.18,-29.73 119.41,-20.52 109.58,-24.46 114.18,-29.73"/>
</a>
</g>
</g>
@@ -176,13 +230,34 @@
<g id="edge8_Node000006_Node000005" class="edge">
<title>Node6&#45;&gt;Node5</title>
<g id="a_edge8_Node000006_Node000005"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M225.36,-55.08C230.71,-47.96 238.43,-37.68 245.1,-28.8"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="247.88,-30.92 251.09,-20.82 242.29,-26.71 247.88,-30.92"/>
<path fill="none" stroke="#63b8ff" d="M101.81,-54.84C133.17,-46.01 181.14,-32.49 215.79,-22.73"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="216.4,-26.19 225.07,-20.11 214.5,-19.46 216.4,-26.19"/>
</a>
</g>
</g>
</g>
</svg>
<g id="navigator" transform="translate(0 0)" fill="#404254">
<rect fill="#f2f5e9" fill-opacity="0.5" stroke="#606060" stroke-width=".5" x="0" y="0" width="60" height="60"/>
<use id="zoomplus" xlink:href="#zoomPlus" x="17" y="9" onmousedown="handleZoom(evt,'in')"/>
<use id="zoomminus" xlink:href="#zoomMin" x="42" y="9" onmousedown="handleZoom(evt,'out')"/>
<use id="reset" xlink:href="#resetDef" x="30" y="36" onmousedown="handleReset()"/>
<use id="arrowup" xlink:href="#arrowUp" x="0" y="0" onmousedown="handlePan(0,-1)"/>
<use id="arrowright" xlink:href="#arrowRight" x="0" y="0" onmousedown="handlePan(1,0)"/>
<use id="arrowdown" xlink:href="#arrowDown" x="0" y="0" onmousedown="handlePan(0,1)"/>
<use id="arrowleft" xlink:href="#arrowLeft" x="0" y="0" onmousedown="handlePan(-1,0)"/>
</g>
<svg viewBox="0 0 15 15" width="100%" height="30px" preserveAspectRatio="xMaxYMin meet">
<g id="arrow_out" transform="scale(0.3 0.3)">
<a xlink:href="curvilinear_8cpp__incl_org.svg" target="_base">
<rect id="button" ry="5" rx="5" y="6" x="6" height="38" width="38"
fill="#f2f5e9" fill-opacity="0.5" stroke="#606060" stroke-width="1.0"/>
<path id="arrow"
d="M 11.500037,31.436501 C 11.940474,20.09759 22.043105,11.32322 32.158766,21.979434 L 37.068811,17.246167 C 37.068811,17.246167 37.088388,32 37.088388,32 L 22.160133,31.978069 C 22.160133,31.978069 26.997745,27.140456 26.997745,27.140456 C 18.528582,18.264221 13.291696,25.230495 11.500037,31.436501 z"
style="fill:#404040;"/>
</a>
</g>
</svg>
<style type='text/css'>
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 8.2 KiB

After

Width:  |  Height:  |  Size: 12 KiB