docs(docs): built docs

Note for now much of the docs is LLM written. This was done to save time and focus on code development. The docs have been LOOSLEY reviewed. However, the code itself has been either fully written by hand or fully reviewed. Therefore, the docs should at the moment be seen as a loose resource rather than authoratiative (and this is on top of the general ability for docs to drift)
This commit is contained in:
2026-11-09 14:09:44 -05:00
parent d9c4919477
commit 6b57738330
32596 changed files with 4155414 additions and 0 deletions

View File

@@ -0,0 +1,195 @@
<?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 14.1.2 (20260124.0452)
-->
<!-- Title: src/include/serif/dimensions/dimensions.hpp Pages: 1 -->
<svg width="434pt" height="216pt"
viewBox="0.00 0.00 434.00 216.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 211.5)">
<title>src/include/serif/dimensions/dimensions.hpp</title>
<!-- Node1 -->
<g id="Node000001" class="node">
<title>Node1</title>
<g id="a_Node000001"><a xlink:title="File containing prue dimensions. Note that this is not intended to be (nor does it have the capabilit...">
<polygon fill="#999999" stroke="#666666" points="202.37,-207.5 64.87,-207.5 64.87,-177 202.37,-177 202.37,-207.5"/>
<text xml:space="preserve" text-anchor="start" x="72.87" y="-194" font-family="Helvetica,sans-Serif" font-size="10.00">src/include/serif/dimensions</text>
<text xml:space="preserve" text-anchor="middle" x="133.62" y="-182.75" font-family="Helvetica,sans-Serif" font-size="10.00">/dimensions.hpp</text>
</a>
</g>
</g>
<!-- Node2 -->
<g id="Node000002" class="node">
<title>Node2</title>
<g id="a_Node000002"><a xlink:title=" ">
<polygon fill="#e0e0e0" stroke="#999999" points="103.37,-141 37.87,-141 37.87,-121.75 103.37,-121.75 103.37,-141"/>
<text xml:space="preserve" text-anchor="middle" x="70.62" y="-127.5" font-family="Helvetica,sans-Serif" font-size="10.00">string_view</text>
</a>
</g>
</g>
<!-- Node1&#45;&gt;Node2 -->
<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="M118.04,-176.7C109.1,-168.34 97.82,-157.8 88.51,-149.1"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="91.13,-146.76 81.44,-142.48 86.35,-151.87 91.13,-146.76"/>
</a>
</g>
</g>
<!-- Node3 -->
<g id="Node000003" class="node">
<title>Node3</title>
<g id="a_Node000003"><a xlink:href="quantities_8hpp.html" target="_top" xlink:title="This file contains the code to associate numeric data to a dimension. We call this a Quantity and a Q...">
<polygon fill="white" stroke="#666666" points="272.12,-141 121.12,-141 121.12,-121.75 272.12,-121.75 272.12,-141"/>
<text xml:space="preserve" text-anchor="middle" x="196.62" y="-127.5" font-family="Helvetica,sans-Serif" font-size="10.00">serif/dimensions/quantities.hpp</text>
</a>
</g>
</g>
<!-- Node1&#45;&gt;Node3 -->
<g id="edge2_Node000001_Node000003" class="edge">
<title>Node1&#45;&gt;Node3</title>
<g id="a_edge2_Node000001_Node000003"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M149.19,-176.7C158.14,-168.34 169.41,-157.8 178.72,-149.1"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="180.88,-151.87 185.8,-142.48 176.1,-146.76 180.88,-151.87"/>
</a>
</g>
</g>
<!-- Node4 -->
<g id="Node000004" class="node">
<title>Node4</title>
<g id="a_Node000004"><a xlink:title=" ">
<polygon fill="#e0e0e0" stroke="#999999" points="323.49,-19.25 261.74,-19.25 261.74,0 323.49,0 323.49,-19.25"/>
<text xml:space="preserve" text-anchor="middle" x="292.62" y="-5.75" font-family="Helvetica,sans-Serif" font-size="10.00">type_traits</text>
</a>
</g>
</g>
<!-- Node3&#45;&gt;Node4 -->
<g id="edge3_Node000003_Node000004" class="edge">
<title>Node3&#45;&gt;Node4</title>
<g id="a_edge3_Node000003_Node000004"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M222.8,-121.36C239.71,-114.24 260.86,-102.64 273.62,-85.75 285.64,-69.82 290.11,-47.13 291.74,-30.86"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="295.23,-31.17 292.43,-20.95 288.25,-30.68 295.23,-31.17"/>
</a>
</g>
</g>
<!-- Node5 -->
<g id="Node000005" class="node">
<title>Node5</title>
<g id="a_Node000005"><a xlink:title=" ">
<polygon fill="#e0e0e0" stroke="#999999" points="68.37,-80.12 14.87,-80.12 14.87,-60.88 68.37,-60.88 68.37,-80.12"/>
<text xml:space="preserve" text-anchor="middle" x="41.62" y="-66.62" font-family="Helvetica,sans-Serif" font-size="10.00">compare</text>
</a>
</g>
</g>
<!-- Node3&#45;&gt;Node5 -->
<g id="edge4_Node000003_Node000005" class="edge">
<title>Node3&#45;&gt;Node5</title>
<g id="a_edge4_Node000003_Node000005"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M171.95,-121.27C147.85,-112.35 110.15,-98.29 77.62,-85.75 76.68,-85.39 75.74,-85.02 74.78,-84.65"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="76.44,-81.55 65.86,-81.16 73.89,-88.06 76.44,-81.55"/>
</a>
</g>
</g>
<!-- Node6 -->
<g id="Node000006" class="node">
<title>Node6</title>
<g id="a_Node000006"><a xlink:title=" ">
<polygon fill="#e0e0e0" stroke="#999999" points="95.49,-19.25 39.74,-19.25 39.74,0 95.49,0 95.49,-19.25"/>
<text xml:space="preserve" text-anchor="middle" x="67.62" y="-5.75" font-family="Helvetica,sans-Serif" font-size="10.00">concepts</text>
</a>
</g>
</g>
<!-- Node3&#45;&gt;Node6 -->
<g id="edge5_Node000003_Node000006" class="edge">
<title>Node3&#45;&gt;Node6</title>
<g id="a_edge5_Node000003_Node000006"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M120.83,-122.29C73.99,-115.56 20.14,-104.06 5.62,-85.75 -2.81,-75.13 -0.56,-67.31 5.62,-55.25 12.23,-42.34 24.51,-32.32 36.41,-25.07"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="37.82,-28.29 44.86,-20.37 34.42,-22.17 37.82,-28.29"/>
</a>
</g>
</g>
<!-- Node7 -->
<g id="Node000007" class="node">
<title>Node7</title>
<g id="a_Node000007"><a xlink:title=" ">
<polygon fill="#e0e0e0" stroke="#999999" points="264.12,-80.12 227.12,-80.12 227.12,-60.88 264.12,-60.88 264.12,-80.12"/>
<text xml:space="preserve" text-anchor="middle" x="245.62" y="-66.62" font-family="Helvetica,sans-Serif" font-size="10.00">tuple</text>
</a>
</g>
</g>
<!-- Node3&#45;&gt;Node7 -->
<g id="edge6_Node000003_Node000007" class="edge">
<title>Node3&#45;&gt;Node7</title>
<g id="a_edge6_Node000003_Node000007"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M204.06,-121.43C211.18,-112.87 222.12,-99.73 230.99,-89.07"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="233.43,-91.61 237.14,-81.69 228.05,-87.14 233.43,-91.61"/>
</a>
</g>
</g>
<!-- Node8 -->
<g id="Node000008" class="node">
<title>Node8</title>
<g id="a_Node000008"><a xlink:href="cleaning_8hpp.html" target="_top" xlink:title=" ">
<polygon fill="white" stroke="#666666" points="426.24,-85.75 320.99,-85.75 320.99,-55.25 426.24,-55.25 426.24,-85.75"/>
<text xml:space="preserve" text-anchor="start" x="328.99" y="-72.25" font-family="Helvetica,sans-Serif" font-size="10.00">serif/utils/misc/std</text>
<text xml:space="preserve" text-anchor="middle" x="373.62" y="-61" font-family="Helvetica,sans-Serif" font-size="10.00">_helper/cleaning.hpp</text>
</a>
</g>
</g>
<!-- Node3&#45;&gt;Node8 -->
<g id="edge7_Node000003_Node000008" class="edge">
<title>Node3&#45;&gt;Node8</title>
<g id="a_edge7_Node000003_Node000008"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M223.89,-121.3C249.04,-112.94 287.14,-100.26 318.62,-89.79"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="319.62,-93.15 328,-86.67 317.41,-86.51 319.62,-93.15"/>
</a>
</g>
</g>
<!-- Node9 -->
<g id="Node000009" class="node">
<title>Node9</title>
<g id="a_Node000009"><a xlink:href="numeric_8hpp.html" target="_top" xlink:title=" ">
<polygon fill="white" stroke="#666666" points="208.87,-85.75 86.37,-85.75 86.37,-55.25 208.87,-55.25 208.87,-85.75"/>
<text xml:space="preserve" text-anchor="start" x="94.37" y="-72.25" font-family="Helvetica,sans-Serif" font-size="10.00">serif/utils/misc/concepts</text>
<text xml:space="preserve" text-anchor="middle" x="147.62" y="-61" font-family="Helvetica,sans-Serif" font-size="10.00">/numeric.hpp</text>
</a>
</g>
</g>
<!-- Node3&#45;&gt;Node9 -->
<g id="edge9_Node000003_Node000009" class="edge">
<title>Node3&#45;&gt;Node9</title>
<g id="a_edge9_Node000003_Node000009"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M189.18,-121.43C183.25,-114.31 174.68,-104.02 166.87,-94.63"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="169.77,-92.64 160.68,-87.2 164.39,-97.12 169.77,-92.64"/>
</a>
</g>
</g>
<!-- Node8&#45;&gt;Node4 -->
<g id="edge8_Node000008_Node000004" class="edge">
<title>Node8&#45;&gt;Node4</title>
<g id="a_edge8_Node000008_Node000004"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M353.59,-54.95C341.62,-46.24 326.4,-35.18 314.16,-26.28"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="316.48,-23.64 306.33,-20.59 312.36,-29.3 316.48,-23.64"/>
</a>
</g>
</g>
<!-- Node9&#45;&gt;Node4 -->
<g id="edge11_Node000009_Node000004" class="edge">
<title>Node9&#45;&gt;Node4</title>
<g id="a_edge11_Node000009_Node000004"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M183.83,-54.8C207.19,-45.31 237.31,-33.08 259.94,-23.89"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="261.03,-27.23 268.98,-20.22 258.4,-20.74 261.03,-27.23"/>
</a>
</g>
</g>
<!-- Node9&#45;&gt;Node6 -->
<g id="edge10_Node000009_Node000006" class="edge">
<title>Node9&#45;&gt;Node6</title>
<g id="a_edge10_Node000009_Node000006"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M127.84,-54.95C116.01,-46.24 100.98,-35.18 88.89,-26.28"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="91.3,-23.71 81.17,-20.6 87.15,-29.34 91.3,-23.71"/>
</a>
</g>
</g>
</g>
</svg>

After

Width:  |  Height:  |  Size: 9.1 KiB