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,146 @@
<?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/equations/arithmetic.hpp Pages: 1 -->
<svg width="660pt" height="183pt"
viewBox="0.00 0.00 660.00 183.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 178.75)">
<title>src/include/serif/equations/arithmetic.hpp</title>
<!-- Node1 -->
<g id="Node000001" class="node">
<title>Node1</title>
<g id="a_Node000001"><a xlink:title="File containing the EquationScale and EquationSum templates, which allow for scaling and summing equa...">
<polygon fill="#999999" stroke="#666666" points="558.5,-174.75 428.5,-174.75 428.5,-144.25 558.5,-144.25 558.5,-174.75"/>
<text xml:space="preserve" text-anchor="start" x="436.5" y="-161.25" font-family="Helvetica,sans-Serif" font-size="10.00">src/include/serif/equations</text>
<text xml:space="preserve" text-anchor="middle" x="493.5" y="-150" font-family="Helvetica,sans-Serif" font-size="10.00">/arithmetic.hpp</text>
</a>
</g>
</g>
<!-- Node2 -->
<g id="Node000002" class="node">
<title>Node2</title>
<g id="a_Node000002"><a xlink:href="displacement__force_8hpp.html" target="_top" xlink:title="File containing the DisplacementForce class, which represents the mechanical balance equation in SERi...">
<polygon fill="white" stroke="#666666" points="438.5,-108.25 308.5,-108.25 308.5,-77.75 438.5,-77.75 438.5,-108.25"/>
<text xml:space="preserve" text-anchor="start" x="316.5" y="-94.75" font-family="Helvetica,sans-Serif" font-size="10.00">src/include/serif/equations</text>
<text xml:space="preserve" text-anchor="middle" x="373.5" y="-83.5" font-family="Helvetica,sans-Serif" font-size="10.00">/displacement_force.hpp</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="M456.37,-138.54C438.35,-128.86 417.09,-117.43 400.62,-108.58"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="454.47,-141.5 464.94,-143.15 457.79,-135.33 454.47,-141.5"/>
</a>
</g>
</g>
<!-- Node6 -->
<g id="Node000006" class="node">
<title>Node6</title>
<g id="a_Node000006"><a xlink:href="equations_8hpp.html" target="_top" xlink:title="File containing the equations module. This module contains the equations used in the SERiF framework.">
<polygon fill="white" stroke="#666666" points="585.5,-36.12 455.5,-36.12 455.5,-5.62 585.5,-5.62 585.5,-36.12"/>
<text xml:space="preserve" text-anchor="start" x="463.5" y="-22.62" font-family="Helvetica,sans-Serif" font-size="10.00">src/include/serif/equations</text>
<text xml:space="preserve" text-anchor="middle" x="520.5" y="-11.38" font-family="Helvetica,sans-Serif" font-size="10.00">/equations.hpp</text>
</a>
</g>
</g>
<!-- Node1&#45;&gt;Node6 -->
<g id="edge6_Node000001_Node000006" class="edge">
<title>Node1&#45;&gt;Node6</title>
<g id="a_edge6_Node000001_Node000006"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M498.58,-132.79C504.21,-104.29 513.1,-59.33 517.63,-36.39"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="495.19,-131.91 496.68,-142.39 502.06,-133.26 495.19,-131.91"/>
</a>
</g>
</g>
<!-- Node7 -->
<g id="Node000007" class="node">
<title>Node7</title>
<g id="a_Node000007"><a xlink:href="sum_8hpp.html" target="_top" xlink:title=" ">
<polygon fill="white" stroke="#666666" points="651.5,-108.25 521.5,-108.25 521.5,-77.75 651.5,-77.75 651.5,-108.25"/>
<text xml:space="preserve" text-anchor="start" x="529.5" y="-94.75" font-family="Helvetica,sans-Serif" font-size="10.00">src/include/serif/equations</text>
<text xml:space="preserve" text-anchor="middle" x="586.5" y="-83.5" font-family="Helvetica,sans-Serif" font-size="10.00">/sum.hpp</text>
</a>
</g>
</g>
<!-- Node1&#45;&gt;Node7 -->
<g id="edge7_Node000001_Node000007" class="edge">
<title>Node1&#45;&gt;Node7</title>
<g id="a_edge7_Node000001_Node000007"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M524.04,-137.32C537.61,-127.91 553.25,-117.06 565.48,-108.58"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="522.07,-134.43 515.85,-143 526.06,-140.18 522.07,-134.43"/>
</a>
</g>
</g>
<!-- Node3 -->
<g id="Node000003" class="node">
<title>Node3</title>
<g id="a_Node000003"><a xlink:href="execution__validation_8cpp.html" target="_top" xlink:title=" ">
<polygon fill="white" stroke="#666666" points="127,-41.75 0,-41.75 0,0 127,0 127,-41.75"/>
<text xml:space="preserve" text-anchor="start" x="8" y="-28.25" font-family="Helvetica,sans-Serif" font-size="10.00">src/compile_time_checks</text>
<text xml:space="preserve" text-anchor="start" x="8" y="-17" font-family="Helvetica,sans-Serif" font-size="10.00">/serif/model/execution</text>
<text xml:space="preserve" text-anchor="middle" x="63.5" y="-5.75" font-family="Helvetica,sans-Serif" font-size="10.00">_validation.cpp</text>
</a>
</g>
</g>
<!-- Node2&#45;&gt;Node3 -->
<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="M296.93,-76.91C250.39,-67.46 189.85,-54.66 136.5,-41.75 133.44,-41.01 130.3,-40.23 127.15,-39.43"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="296.16,-80.33 306.66,-78.88 297.55,-73.47 296.16,-80.33"/>
</a>
</g>
</g>
<!-- Node4 -->
<g id="Node000004" class="node">
<title>Node4</title>
<g id="a_Node000004"><a xlink:href="normalization_8cpp.html" target="_top" xlink:title=" ">
<polygon fill="white" stroke="#666666" points="291.75,-36.12 145.25,-36.12 145.25,-5.62 291.75,-5.62 291.75,-36.12"/>
<text xml:space="preserve" text-anchor="start" x="153.25" y="-22.62" font-family="Helvetica,sans-Serif" font-size="10.00">src/compile_time_checks</text>
<text xml:space="preserve" text-anchor="middle" x="218.5" y="-11.38" font-family="Helvetica,sans-Serif" font-size="10.00">/serif/model/normalization.cpp</text>
</a>
</g>
</g>
<!-- Node2&#45;&gt;Node4 -->
<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="M330.63,-72.6C305.43,-61.2 274.09,-47.02 250.95,-36.56"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="329.07,-75.74 339.63,-76.68 331.96,-69.36 329.07,-75.74"/>
</a>
</g>
</g>
<!-- Node5 -->
<g id="Node000005" class="node">
<title>Node5</title>
<g id="a_Node000005"><a xlink:href="operators_2plan_8cpp.html" target="_top" xlink:title=" ">
<polygon fill="white" stroke="#666666" points="437,-36.12 310,-36.12 310,-5.62 437,-5.62 437,-36.12"/>
<text xml:space="preserve" text-anchor="start" x="318" y="-22.62" font-family="Helvetica,sans-Serif" font-size="10.00">src/compile_time_checks</text>
<text xml:space="preserve" text-anchor="middle" x="373.5" y="-11.38" font-family="Helvetica,sans-Serif" font-size="10.00">/serif/operators/plan.cpp</text>
</a>
</g>
</g>
<!-- Node2&#45;&gt;Node5 -->
<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="M373.5,-66.02C373.5,-56.01 373.5,-44.94 373.5,-36.39"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="370,-65.96 373.5,-75.96 377,-65.96 370,-65.96"/>
</a>
</g>
</g>
<!-- Node2&#45;&gt;Node6 -->
<g id="edge5_Node000002_Node000006" class="edge">
<title>Node2&#45;&gt;Node6</title>
<g id="a_edge5_Node000002_Node000006"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M414.48,-72.45C438.32,-61.08 467.88,-46.98 489.72,-36.56"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="413.2,-69.18 405.68,-76.65 416.21,-75.5 413.2,-69.18"/>
</a>
</g>
</g>
</g>
</svg>

After

Width:  |  Height:  |  Size: 7.7 KiB