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,269 @@
<?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/geometry/deformation/actions.hpp Pages: 1 -->
<svg width="672pt" height="227pt"
viewBox="0.00 0.00 672.00 227.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 222.75)">
<title>src/include/serif/geometry/deformation/actions.hpp</title>
<!-- Node1 -->
<g id="Node000001" class="node">
<title>Node1</title>
<g id="a_Node000001"><a xlink:title=" ">
<polygon fill="#999999" stroke="#666666" points="288.12,-218.75 159.62,-218.75 159.62,-188.25 288.12,-188.25 288.12,-218.75"/>
<text xml:space="preserve" text-anchor="start" x="167.62" y="-205.25" font-family="Helvetica,sans-Serif" font-size="10.00">src/include/serif/geometry</text>
<text xml:space="preserve" text-anchor="middle" x="223.88" y="-194" font-family="Helvetica,sans-Serif" font-size="10.00">/deformation/actions.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="55.75,-80.12 0,-80.12 0,-60.88 55.75,-60.88 55.75,-80.12"/>
<text xml:space="preserve" text-anchor="middle" x="27.88" y="-66.62" font-family="Helvetica,sans-Serif" font-size="10.00">algorithm</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="M184.2,-187.77C162.8,-178.96 136.43,-166.69 114.88,-152.25 87.17,-133.7 59.73,-106.34 43.29,-88.72"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="46.11,-86.62 36.78,-81.61 40.95,-91.34 46.11,-86.62"/>
</a>
</g>
</g>
<!-- Node3 -->
<g id="Node000003" class="node">
<title>Node3</title>
<g id="a_Node000003"><a xlink:title=" ">
<polygon fill="#e0e0e0" stroke="#999999" points="363.75,-146.62 308,-146.62 308,-127.38 363.75,-127.38 363.75,-146.62"/>
<text xml:space="preserve" text-anchor="middle" x="335.88" y="-133.12" font-family="Helvetica,sans-Serif" font-size="10.00">concepts</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="M249.29,-187.86C267.53,-177.36 292,-163.27 310.28,-152.74"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="312,-155.79 318.92,-147.77 308.51,-149.72 312,-155.79"/>
</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="110.38,-80.12 73.38,-80.12 73.38,-60.88 110.38,-60.88 110.38,-80.12"/>
<text xml:space="preserve" text-anchor="middle" x="91.88" y="-66.62" font-family="Helvetica,sans-Serif" font-size="10.00">span</text>
</a>
</g>
</g>
<!-- Node1&#45;&gt;Node4 -->
<g id="edge3_Node000001_Node000004" class="edge">
<title>Node1&#45;&gt;Node4</title>
<g id="a_edge3_Node000001_Node000004"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M191.81,-187.76C175.27,-179.07 155.53,-166.89 140.88,-152.25 122.79,-134.19 108.57,-108.19 100.2,-90.61"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="103.53,-89.47 96.2,-81.82 97.16,-92.37 103.53,-89.47"/>
</a>
</g>
</g>
<!-- Node5 -->
<g id="Node000005" class="node">
<title>Node5</title>
<g id="a_Node000005"><a xlink:href="failure_8hpp.html" target="_top" xlink:title=" ">
<polygon fill="white" stroke="#666666" points="261,-85.75 128.75,-85.75 128.75,-55.25 261,-55.25 261,-85.75"/>
<text xml:space="preserve" text-anchor="start" x="136.75" y="-72.25" font-family="Helvetica,sans-Serif" font-size="10.00">serif/geometry/deformation</text>
<text xml:space="preserve" text-anchor="middle" x="194.88" y="-61" font-family="Helvetica,sans-Serif" font-size="10.00">/failure.hpp</text>
</a>
</g>
</g>
<!-- Node1&#45;&gt;Node5 -->
<g id="edge4_Node000001_Node000005" class="edge">
<title>Node1&#45;&gt;Node5</title>
<g id="a_edge4_Node000001_Node000005"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M188.01,-187.82C173.08,-179.7 157.29,-168.01 148.88,-152.25 138.27,-132.37 152.92,-110.15 168.43,-94.06"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="170.66,-96.77 175.41,-87.3 165.79,-91.75 170.66,-96.77"/>
</a>
</g>
</g>
<!-- Node8 -->
<g id="Node000008" class="node">
<title>Node8</title>
<g id="a_Node000008"><a xlink:href="action__storage_8hpp.html" target="_top" xlink:title=" ">
<polygon fill="white" stroke="#666666" points="290,-152.25 157.75,-152.25 157.75,-121.75 290,-121.75 290,-152.25"/>
<text xml:space="preserve" text-anchor="start" x="165.75" y="-138.75" font-family="Helvetica,sans-Serif" font-size="10.00">serif/geometry/deformation</text>
<text xml:space="preserve" text-anchor="middle" x="223.88" y="-127.5" font-family="Helvetica,sans-Serif" font-size="10.00">/detail/action_storage.hpp</text>
</a>
</g>
</g>
<!-- Node1&#45;&gt;Node8 -->
<g id="edge7_Node000001_Node000008" class="edge">
<title>Node1&#45;&gt;Node8</title>
<g id="a_edge7_Node000001_Node000008"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M223.88,-187.86C223.88,-180.77 223.88,-172.04 223.88,-163.88"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="227.38,-164.09 223.88,-154.09 220.38,-164.09 227.38,-164.09"/>
</a>
</g>
</g>
<!-- Node12 -->
<g id="Node000012" class="node">
<title>Node12</title>
<g id="a_Node000012"><a xlink:href="spaces_8hpp.html" target="_top" xlink:title=" ">
<polygon fill="white" stroke="#666666" points="514,-152.25 381.75,-152.25 381.75,-121.75 514,-121.75 514,-152.25"/>
<text xml:space="preserve" text-anchor="start" x="389.75" y="-138.75" font-family="Helvetica,sans-Serif" font-size="10.00">serif/geometry/deformation</text>
<text xml:space="preserve" text-anchor="middle" x="447.88" y="-127.5" font-family="Helvetica,sans-Serif" font-size="10.00">/spaces.hpp</text>
</a>
</g>
</g>
<!-- Node1&#45;&gt;Node12 -->
<g id="edge14_Node000001_Node000012" class="edge">
<title>Node1&#45;&gt;Node12</title>
<g id="a_edge14_Node000001_Node000012"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M274.98,-187.78C307.96,-178.29 351.05,-165.88 385.96,-155.83"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="386.89,-159.2 395.53,-153.07 384.95,-152.48 386.89,-159.2"/>
</a>
</g>
</g>
<!-- Node13 -->
<g id="Node000013" class="node">
<title>Node13</title>
<g id="a_Node000013"><a xlink:href="geometry_2deformation_2workspace_8hpp.html" target="_top" xlink:title=" ">
<polygon fill="white" stroke="#666666" points="664,-152.25 531.75,-152.25 531.75,-121.75 664,-121.75 664,-152.25"/>
<text xml:space="preserve" text-anchor="start" x="539.75" y="-138.75" font-family="Helvetica,sans-Serif" font-size="10.00">serif/geometry/deformation</text>
<text xml:space="preserve" text-anchor="middle" x="597.88" y="-127.5" font-family="Helvetica,sans-Serif" font-size="10.00">/workspace.hpp</text>
</a>
</g>
</g>
<!-- Node1&#45;&gt;Node13 -->
<g id="edge15_Node000001_Node000013" class="edge">
<title>Node1&#45;&gt;Node13</title>
<g id="a_edge15_Node000001_Node000013"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M288.39,-192.06C346.45,-182.58 434.41,-167.99 520.35,-152.68"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="520.92,-156.13 530.15,-150.93 519.69,-149.24 520.92,-156.13"/>
</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="189.75,-19.25 134,-19.25 134,0 189.75,0 189.75,-19.25"/>
<text xml:space="preserve" text-anchor="middle" x="161.88" y="-5.75" font-family="Helvetica,sans-Serif" font-size="10.00">expected</text>
</a>
</g>
</g>
<!-- Node5&#45;&gt;Node6 -->
<g id="edge5_Node000005_Node000006" class="edge">
<title>Node5&#45;&gt;Node6</title>
<g id="a_edge5_Node000005_Node000006"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M186.72,-54.95C182.42,-47.28 177.09,-37.77 172.48,-29.54"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="175.64,-28.03 167.7,-21.02 169.54,-31.46 175.64,-28.03"/>
</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="247.88,-19.25 207.88,-19.25 207.88,0 247.88,0 247.88,-19.25"/>
<text xml:space="preserve" text-anchor="middle" x="227.88" y="-5.75" font-family="Helvetica,sans-Serif" font-size="10.00">string</text>
</a>
</g>
</g>
<!-- Node5&#45;&gt;Node7 -->
<g id="edge6_Node000005_Node000007" class="edge">
<title>Node5&#45;&gt;Node7</title>
<g id="a_edge6_Node000005_Node000007"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M203.03,-54.95C207.33,-47.28 212.66,-37.77 217.27,-29.54"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="220.21,-31.46 222.05,-21.02 214.11,-28.03 220.21,-31.46"/>
</a>
</g>
</g>
<!-- Node8&#45;&gt;Node2 -->
<g id="edge8_Node000008_Node000002" class="edge">
<title>Node8&#45;&gt;Node2</title>
<g id="a_edge8_Node000008_Node000002"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M174.55,-121.27C143.02,-111.64 101.35,-98.52 64.88,-85.75 63.74,-85.35 62.58,-84.94 61.42,-84.52"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="62.9,-81.34 52.31,-81.14 60.46,-87.9 62.9,-81.34"/>
</a>
</g>
</g>
<!-- Node8&#45;&gt;Node4 -->
<g id="edge12_Node000008_Node000004" class="edge">
<title>Node8&#45;&gt;Node4</title>
<g id="a_edge12_Node000008_Node000004"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M193.3,-121.43C174.57,-112.46 149.9,-100.57 119.64,-85.58"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="121.49,-82.59 110.98,-81.27 118.38,-88.86 121.49,-82.59"/>
</a>
</g>
</g>
<!-- Node8&#45;&gt;Node5 -->
<g id="edge13_Node000008_Node000005" class="edge">
<title>Node8&#45;&gt;Node5</title>
<g id="a_edge13_Node000008_Node000005"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M217.29,-121.36C213.99,-114.02 209.91,-104.93 206.13,-96.52"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="209.34,-95.14 202.05,-87.46 202.96,-98.01 209.34,-95.14"/>
</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="322.38,-80.12 279.38,-80.12 279.38,-60.88 322.38,-60.88 322.38,-80.12"/>
<text xml:space="preserve" text-anchor="middle" x="300.88" y="-66.62" font-family="Helvetica,sans-Serif" font-size="10.00">cmath</text>
</a>
</g>
</g>
<!-- Node8&#45;&gt;Node9 -->
<g id="edge9_Node000008_Node000009" class="edge">
<title>Node8&#45;&gt;Node9</title>
<g id="a_edge9_Node000008_Node000009"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M241.35,-121.36C253.37,-111.29 269.34,-97.92 281.71,-87.56"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="283.76,-90.4 289.18,-81.29 279.27,-85.03 283.76,-90.4"/>
</a>
</g>
</g>
<!-- Node10 -->
<g id="Node000010" class="node">
<title>Node10</title>
<g id="a_Node000010"><a xlink:title=" ">
<polygon fill="#e0e0e0" stroke="#999999" points="398.88,-80.12 340.88,-80.12 340.88,-60.88 398.88,-60.88 398.88,-80.12"/>
<text xml:space="preserve" text-anchor="middle" x="369.88" y="-66.62" font-family="Helvetica,sans-Serif" font-size="10.00">functional</text>
</a>
</g>
</g>
<!-- Node8&#45;&gt;Node10 -->
<g id="edge10_Node000008_Node000010" class="edge">
<title>Node8&#45;&gt;Node10</title>
<g id="a_edge10_Node000008_Node000010"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M257,-121.36C281.66,-110.47 315.08,-95.71 339.15,-85.08"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="340.36,-88.36 348.1,-81.12 337.53,-81.96 340.36,-88.36"/>
</a>
</g>
</g>
<!-- Node11 -->
<g id="Node000011" class="node">
<title>Node11</title>
<g id="a_Node000011"><a xlink:title=" ">
<polygon fill="#e0e0e0" stroke="#999999" points="489,-80.12 416.75,-80.12 416.75,-60.88 489,-60.88 489,-80.12"/>
<text xml:space="preserve" text-anchor="middle" x="452.88" y="-66.62" font-family="Helvetica,sans-Serif" font-size="10.00">initializer_list</text>
</a>
</g>
</g>
<!-- Node8&#45;&gt;Node11 -->
<g id="edge11_Node000008_Node000011" class="edge">
<title>Node8&#45;&gt;Node11</title>
<g id="a_edge11_Node000008_Node000011"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M280,-121.3C316.53,-111.57 365.15,-98.34 407.88,-85.75 409.85,-85.17 411.88,-84.56 413.92,-83.94"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="414.87,-87.31 423.4,-81.01 412.81,-80.62 414.87,-87.31"/>
</a>
</g>
</g>
</g>
</svg>

After

Width:  |  Height:  |  Size: 12 KiB