docs(docs): asdded and cleaned up docs

This commit is contained in:
2025-07-24 11:10:45 -04:00
parent cc3708fda5
commit ba9b3e2392
808 changed files with 140326 additions and 9346 deletions

View File

@@ -0,0 +1,263 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GridFire: src/python/engine/bindings.cpp File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">GridFire<span id="projectnumber">&#160;0.0.1a</span>
</div>
<div id="projectbrief">General Purpose Nuclear Network</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('engine_2bindings_8cpp.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#concepts">Concepts</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">bindings.cpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;pybind11/pybind11.h&gt;</code><br />
<code>#include &lt;pybind11/stl.h&gt;</code><br />
<code>#include &lt;pybind11/stl_bind.h&gt;</code><br />
<code>#include &lt;iostream&gt;</code><br />
<code>#include &quot;<a class="el" href="engine_2bindings_8h_source.html">bindings.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="engine_8h_source.html">gridfire/engine/engine.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="py__engine_8h_source.html">trampoline/py_engine.h</a>&quot;</code><br />
</div>
<p><a href="engine_2bindings_8cpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="concepts" name="concepts"></a>
Concepts</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">concept &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="concept_0d012022023301355052304263320136165002200160012126_1_1_is_dynamic_engine.html">@012022023301355052304263320136165002200160012126::IsDynamicEngine</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ac2df9cd0e71d39b97ddd47b3e7024b0c" id="r_ac2df9cd0e71d39b97ddd47b3e7024b0c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac2df9cd0e71d39b97ddd47b3e7024b0c">register_engine_bindings</a> (py::module &amp;m)</td></tr>
<tr class="separator:ac2df9cd0e71d39b97ddd47b3e7024b0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a884aac3c3f2e8c62843c69329052d642" id="r_a884aac3c3f2e8c62843c69329052d642"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a884aac3c3f2e8c62843c69329052d642">register_base_engine_bindings</a> (pybind11::module &amp;m)</td></tr>
<tr class="separator:a884aac3c3f2e8c62843c69329052d642"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01ff627d4ef6a21b3323cd383dd29841" id="r_a01ff627d4ef6a21b3323cd383dd29841"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a01ff627d4ef6a21b3323cd383dd29841">abs_stype_register_engine_bindings</a> (pybind11::module &amp;m)</td></tr>
<tr class="separator:a01ff627d4ef6a21b3323cd383dd29841"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4066aaf2dca39ee1ed37ad53169f1cdf" id="r_a4066aaf2dca39ee1ed37ad53169f1cdf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4066aaf2dca39ee1ed37ad53169f1cdf">abs_stype_register_dynamic_engine_bindings</a> (pybind11::module &amp;m)</td></tr>
<tr class="separator:a4066aaf2dca39ee1ed37ad53169f1cdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61b016667b7477d898be2a2a5bc7cab8" id="r_a61b016667b7477d898be2a2a5bc7cab8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a61b016667b7477d898be2a2a5bc7cab8">con_stype_register_graph_engine_bindings</a> (pybind11::module &amp;m)</td></tr>
<tr class="separator:a61b016667b7477d898be2a2a5bc7cab8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74a027923ac27f235cf565f8d2a355bd" id="r_a74a027923ac27f235cf565f8d2a355bd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a74a027923ac27f235cf565f8d2a355bd">register_engine_view_bindings</a> (pybind11::module &amp;m)</td></tr>
<tr class="separator:a74a027923ac27f235cf565f8d2a355bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a4066aaf2dca39ee1ed37ad53169f1cdf" name="a4066aaf2dca39ee1ed37ad53169f1cdf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4066aaf2dca39ee1ed37ad53169f1cdf">&#9670;&#160;</a></span>abs_stype_register_dynamic_engine_bindings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void abs_stype_register_dynamic_engine_bindings </td>
<td>(</td>
<td class="paramtype">pybind11::module &amp;</td> <td class="paramname"><span class="paramname"><em>m</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="engine_2bindings_8cpp_source.html#l00172">172</a> of file <a class="el" href="engine_2bindings_8cpp_source.html">bindings.cpp</a>.</p>
</div>
</div>
<a id="a01ff627d4ef6a21b3323cd383dd29841" name="a01ff627d4ef6a21b3323cd383dd29841"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01ff627d4ef6a21b3323cd383dd29841">&#9670;&#160;</a></span>abs_stype_register_engine_bindings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void abs_stype_register_engine_bindings </td>
<td>(</td>
<td class="paramtype">pybind11::module &amp;</td> <td class="paramname"><span class="paramname"><em>m</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="engine_2bindings_8cpp_source.html#l00168">168</a> of file <a class="el" href="engine_2bindings_8cpp_source.html">bindings.cpp</a>.</p>
</div>
</div>
<a id="a61b016667b7477d898be2a2a5bc7cab8" name="a61b016667b7477d898be2a2a5bc7cab8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61b016667b7477d898be2a2a5bc7cab8">&#9670;&#160;</a></span>con_stype_register_graph_engine_bindings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void con_stype_register_graph_engine_bindings </td>
<td>(</td>
<td class="paramtype">pybind11::module &amp;</td> <td class="paramname"><span class="paramname"><em>m</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="engine_2bindings_8cpp_source.html#l00176">176</a> of file <a class="el" href="engine_2bindings_8cpp_source.html">bindings.cpp</a>.</p>
</div>
</div>
<a id="a884aac3c3f2e8c62843c69329052d642" name="a884aac3c3f2e8c62843c69329052d642"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a884aac3c3f2e8c62843c69329052d642">&#9670;&#160;</a></span>register_base_engine_bindings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void register_base_engine_bindings </td>
<td>(</td>
<td class="paramtype">pybind11::module &amp;</td> <td class="paramname"><span class="paramname"><em>m</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="engine_2bindings_8cpp_source.html#l00155">155</a> of file <a class="el" href="engine_2bindings_8cpp_source.html">bindings.cpp</a>.</p>
</div>
</div>
<a id="ac2df9cd0e71d39b97ddd47b3e7024b0c" name="ac2df9cd0e71d39b97ddd47b3e7024b0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac2df9cd0e71d39b97ddd47b3e7024b0c">&#9670;&#160;</a></span>register_engine_bindings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void register_engine_bindings </td>
<td>(</td>
<td class="paramtype">py::module &amp;</td> <td class="paramname"><span class="paramname"><em>m</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="engine_2bindings_8cpp_source.html#l00114">114</a> of file <a class="el" href="engine_2bindings_8cpp_source.html">bindings.cpp</a>.</p>
</div>
</div>
<a id="a74a027923ac27f235cf565f8d2a355bd" name="a74a027923ac27f235cf565f8d2a355bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a74a027923ac27f235cf565f8d2a355bd">&#9670;&#160;</a></span>register_engine_view_bindings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void register_engine_view_bindings </td>
<td>(</td>
<td class="paramtype">pybind11::module &amp;</td> <td class="paramname"><span class="paramname"><em>m</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="engine_2bindings_8cpp_source.html#l00270">270</a> of file <a class="el" href="engine_2bindings_8cpp_source.html">bindings.cpp</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_5c0d64f70903e893b1efe571a4b8de29.html">python</a></li><li class="navelem"><a class="el" href="dir_d0a49494bbb6e91de214e6669adf5efa.html">engine</a></li><li class="navelem"><a class="el" href="engine_2bindings_8cpp.html">bindings.cpp</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
</ul>
</div>
</body>
</html>