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

docs(docs): built docs

Browse Source 
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:
Emily Boudreaux
2026-11-09 14:09:44 -05:00
parent d9c4919477
commit 6b57738330
32596 changed files with 4155414 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

162
docs/html/dimensions_2runtime_2runtime_8hpp__dep__incl.svg Normal file
View File

@@ -0,0 +1,162 @@
<?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/runtime/runtime.hpp Pages: 1 -->
<svg width="294pt" height="371pt"
viewBox="0.00 0.00 294.00 371.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<svg id="main" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve">
<style type="text/css"><![CDATA[
.node, .edge {opacity: 0.7;}
.node.selected, .edge.selected {opacity: 1;}
.edge:hover path { stroke: red; }
.edge:hover polygon { stroke: red; fill: red; }
]]></style>
<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 367)">
<title>src/include/serif/dimensions/runtime/runtime.hpp</title>
<!-- Node1 -->
<g id="Node000001" class="node">
<title>Node1</title>
<g id="a_Node000001"><a xlink:title="runtime usable types representing the compile time dimension type system. Note that generally this is...">
<polygon fill="#999999" stroke="#666666" points="211.75,-363 74.25,-363 74.25,-332.5 211.75,-332.5 211.75,-363"/>
<text xml:space="preserve" text-anchor="start" x="82.25" y="-349.5" font-family="Helvetica,sans-Serif" font-size="10.00">src/include/serif/dimensions</text>
<text xml:space="preserve" text-anchor="middle" x="143" y="-338.25" font-family="Helvetica,sans-Serif" font-size="10.00">/runtime/runtime.hpp</text>
</a>
</g>
</g>
<!-- Node2 -->
<g id="Node000002" class="node">
<title>Node2</title>
<g id="a_Node000002"><a xlink:href="dimensions_2runtime_2concepts_8hpp.html" target="_top" xlink:title="Runtime concept for a type that can be projected to a runtime type. This is useful when converting fr...">
<polygon fill="white" stroke="#666666" points="211.75,-296.5 74.25,-296.5 74.25,-266 211.75,-266 211.75,-296.5"/>
<text xml:space="preserve" text-anchor="start" x="82.25" y="-283" font-family="Helvetica,sans-Serif" font-size="10.00">src/include/serif/dimensions</text>
<text xml:space="preserve" text-anchor="middle" x="143" y="-271.75" font-family="Helvetica,sans-Serif" font-size="10.00">/runtime/concepts.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="M143,-320.81C143,-312.64 143,-303.91 143,-296.83"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="139.5,-320.6 143,-330.6 146.5,-320.6 139.5,-320.6"/>
</a>
</g>
</g>
<!-- Node3 -->
<g id="Node000003" class="node">
<title>Node3</title>
<g id="a_Node000003"><a xlink:href="eos_2runtime_2details_8hpp.html" target="_top" xlink:title="File containing implementation details for the eos runtime module. These details are used internally ...">
<polygon fill="white" stroke="#666666" points="194.88,-230 91.12,-230 91.12,-199.5 194.88,-199.5 194.88,-230"/>
<text xml:space="preserve" text-anchor="start" x="99.12" y="-216.5" font-family="Helvetica,sans-Serif" font-size="10.00">src/include/serif/eos</text>
<text xml:space="preserve" text-anchor="middle" x="143" y="-205.25" font-family="Helvetica,sans-Serif" font-size="10.00">/runtime/details.hpp</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="M143,-254.31C143,-246.14 143,-237.41 143,-230.33"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="139.5,-254.1 143,-264.1 146.5,-254.1 139.5,-254.1"/>
</a>
</g>
</g>
<!-- Node4 -->
<g id="Node000004" class="node">
<title>Node4</title>
<g id="a_Node000004"><a xlink:href="details_8cpp.html" target="_top" xlink:title=" ">
<polygon fill="white" stroke="#666666" points="142,-163.5 0,-163.5 0,-133 142,-133 142,-163.5"/>
<text xml:space="preserve" text-anchor="start" x="8" y="-150" font-family="Helvetica,sans-Serif" font-size="10.00">src/compile_time_checks</text>
<text xml:space="preserve" text-anchor="middle" x="71" y="-138.75" font-family="Helvetica,sans-Serif" font-size="10.00">/serif/eos/runtime/details.cpp</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="M118.12,-191.46C107.91,-182.32 96.38,-171.98 87.27,-163.83"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="115.75,-194.04 125.53,-198.1 120.42,-188.82 115.75,-194.04"/>
</a>
</g>
</g>
<!-- Node5 -->
<g id="Node000005" class="node">
<title>Node5</title>
<g id="a_Node000005"><a xlink:href="eos_2runtime_2concepts_8hpp.html" target="_top" xlink:title="File containing concepts for the eos runtime module. These concepts are used to constrain template pa...">
<polygon fill="white" stroke="#666666" points="272.38,-163.5 159.62,-163.5 159.62,-133 272.38,-133 272.38,-163.5"/>
<text xml:space="preserve" text-anchor="start" x="167.62" y="-150" font-family="Helvetica,sans-Serif" font-size="10.00">src/include/serif/eos</text>
<text xml:space="preserve" text-anchor="middle" x="216" y="-138.75" font-family="Helvetica,sans-Serif" font-size="10.00">/runtime/concepts.hpp</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="M167.91,-191.74C178.34,-182.53 190.18,-172.06 199.5,-163.83"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="165.88,-188.87 160.7,-198.11 170.51,-194.11 165.88,-188.87"/>
</a>
</g>
</g>
<!-- Node6 -->
<g id="Node000006" class="node">
<title>Node6</title>
<g id="a_Node000006"><a xlink:href="views_8hpp.html" target="_top" xlink:title="File containing the EOSView class. This class is used to provide a runtime view of an EOS model and i...">
<polygon fill="white" stroke="#666666" points="267.88,-97 164.12,-97 164.12,-66.5 267.88,-66.5 267.88,-97"/>
<text xml:space="preserve" text-anchor="start" x="172.12" y="-83.5" font-family="Helvetica,sans-Serif" font-size="10.00">src/include/serif/eos</text>
<text xml:space="preserve" text-anchor="middle" x="216" y="-72.25" font-family="Helvetica,sans-Serif" font-size="10.00">/runtime/views.hpp</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="M216,-121.31C216,-113.14 216,-104.41 216,-97.33"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="212.5,-121.1 216,-131.1 219.5,-121.1 212.5,-121.1"/>
</a>
</g>
</g>
<!-- Node7 -->
<g id="Node000007" class="node">
<title>Node7</title>
<g id="a_Node000007"><a xlink:href="views_8cpp.html" target="_top" xlink:title=" ">
<polygon fill="white" stroke="#666666" points="285.5,-30.5 146.5,-30.5 146.5,0 285.5,0 285.5,-30.5"/>
<text xml:space="preserve" text-anchor="start" x="154.5" y="-17" font-family="Helvetica,sans-Serif" font-size="10.00">src/compile_time_checks</text>
<text xml:space="preserve" text-anchor="middle" x="216" y="-5.75" font-family="Helvetica,sans-Serif" font-size="10.00">/serif/eos/runtime/views.cpp</text>
</a>
</g>
</g>
<!-- Node6&#45;&gt;Node7 -->
<g id="edge6_Node000006_Node000007" class="edge">
<title>Node6&#45;&gt;Node7</title>
<g id="a_edge6_Node000006_Node000007"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M216,-54.81C216,-46.64 216,-37.91 216,-30.83"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="212.5,-54.6 216,-64.6 219.5,-54.6 212.5,-54.6"/>
</a>
</g>
</g>
</g>
</svg>
</svg>
<style type='text/css'>
<![CDATA[
[data-mouse-over-selected='false'] { opacity: 0.7; }
[data-mouse-over-selected='true'] { opacity: 1.0; }
]]>
</style>
<script type="application/ecmascript"><![CDATA[
document.addEventListener('DOMContentLoaded', (event) => {
highlightEdges();
highlightAdjacentNodes();
});
]]></script>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 8.1 KiB