Skip to content

Commit 990d477

Browse files
committed
Update Doxygen docs.
1 parent 167d121 commit 990d477

23 files changed

+1914
-1583
lines changed

docs/backend_8hpp_source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1189,7 +1189,7 @@
11891189
<div class="ttc" id="anamespacebackend_html_abe34a7f0b2bda67cd57f785c445d482c"><div class="ttname"><a href="namespacebackend.html#abe34a7f0b2bda67cd57f785c445d482c">backend::operator-</a></div><div class="ttdeci">buffer&lt; T &gt; operator-(buffer&lt; T &gt; &amp;a, buffer&lt; T &gt; &amp;b)</div><div class="ttdoc">Subtract operation.</div><div class="ttdef"><b>Definition</b> backend.hpp:815</div></div>
11901190
<div class="ttc" id="anamespacebackend_html_abeae26338271283c565b82dac9f060da"><div class="ttname"><a href="namespacebackend.html#abeae26338271283c565b82dac9f060da">backend::operator+</a></div><div class="ttdeci">buffer&lt; T &gt; operator+(buffer&lt; T &gt; &amp;a, buffer&lt; T &gt; &amp;b)</div><div class="ttdoc">Add operation.</div><div class="ttdef"><b>Definition</b> backend.hpp:757</div></div>
11911191
<div class="ttc" id="anamespacebackend_html_aeaba48a58e10e1225cc01603bf48cf6f"><div class="ttname"><a href="namespacebackend.html#aeaba48a58e10e1225cc01603bf48cf6f">backend::pow</a></div><div class="ttdeci">buffer&lt; T &gt; pow(buffer&lt; T &gt; &amp;base, buffer&lt; T &gt; &amp;exponent)</div><div class="ttdoc">Take the power.</div><div class="ttdef"><b>Definition</b> backend.hpp:1025</div></div>
1192-
<div class="ttc" id="anamespacespecial_html_a8e79c36d1f8048f7c492e72ff6c0fd93"><div class="ttname"><a href="namespacespecial.html#a8e79c36d1f8048f7c492e72ff6c0fd93">special::erfi</a></div><div class="ttdeci">complex_type&lt; T &gt; erfi(const complex_type&lt; T &gt; z)</div><div class="ttdoc">erfi(z) = -i erf(iz)</div><div class="ttdef"><b>Definition</b> special_functions.hpp:1580</div></div>
1192+
<div class="ttc" id="anamespacespecial_html_a8e79c36d1f8048f7c492e72ff6c0fd93"><div class="ttname"><a href="namespacespecial.html#a8e79c36d1f8048f7c492e72ff6c0fd93">special::erfi</a></div><div class="ttdeci">complex_type&lt; T &gt; erfi(const complex_type&lt; T &gt; z)</div><div class="ttdoc">erfi(z) = -i erf(iz)</div><div class="ttdef"><b>Definition</b> special_functions.hpp:1588</div></div>
11931193
<div class="ttc" id="aregister_8hpp_html"><div class="ttname"><a href="register_8hpp.html">register.hpp</a></div><div class="ttdoc">Utilities for writting jit source code.</div></div>
11941194
<div class="ttc" id="aspecial__functions_8hpp_html"><div class="ttname"><a href="special__functions_8hpp.html">special_functions.hpp</a></div><div class="ttdoc">Implimentations for special functions.</div></div>
11951195
</div><!-- fragment --></div><!-- contents -->

docs/commandline__parser_8hpp_source.html

Lines changed: 128 additions & 130 deletions
Large diffs are not rendered by default.

docs/dir_b94ac65fd6b6212c4d2022b0f23d243a.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,9 @@
126126
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><a href="equilibrium_8hpp_source.html"><span class="icondoc"></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="equilibrium_8hpp.html">equilibrium.hpp</a></td></tr>
127127
<tr class="memdesc:equilibrium_8hpp"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class signature to impliment plasma equilibrium. <br /></td></tr>
128128
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
129+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><a href="graph__framework_8hpp_source.html"><span class="icondoc"></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="graph__framework_8hpp.html">graph_framework.hpp</a></td></tr>
130+
<tr class="memdesc:graph__framework_8hpp"><td class="mdescLeft">&#160;</td><td class="mdescRight">Single include header for the entire framework. <br /></td></tr>
131+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
129132
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><a href="jit_8hpp_source.html"><span class="icondoc"></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="jit_8hpp.html">jit.hpp</a></td></tr>
130133
<tr class="memdesc:jit_8hpp"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class to just in time compile a kernel. <br /></td></tr>
131134
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>

docs/dir_b94ac65fd6b6212c4d2022b0f23d243a.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ var dir_b94ac65fd6b6212c4d2022b0f23d243a =
88
[ "cuda_context.hpp", "cuda__context_8hpp.html", "cuda__context_8hpp" ],
99
[ "dispersion.hpp", "dispersion_8hpp.html", "dispersion_8hpp" ],
1010
[ "equilibrium.hpp", "equilibrium_8hpp.html", "equilibrium_8hpp" ],
11+
[ "graph_framework.hpp", "graph__framework_8hpp.html", null ],
1112
[ "jit.hpp", "jit_8hpp.html", "jit_8hpp" ],
1213
[ "math.hpp", "math_8hpp.html", "math_8hpp" ],
1314
[ "metal_context.hpp", "metal__context_8hpp.html", "metal__context_8hpp" ],

docs/files.html

Lines changed: 39 additions & 38 deletions
Large diffs are not rendered by default.

docs/graph__framework_8hpp.html

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.9.8"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Graph Framework: graph_framework/graph_framework.hpp File Reference</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="resize.js"></script>
14+
<script type="text/javascript" src="navtreedata.js"></script>
15+
<script type="text/javascript" src="navtree.js"></script>
16+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
17+
<script type="text/javascript" src="search/searchdata.js"></script>
18+
<script type="text/javascript" src="search/search.js"></script>
19+
<script type="text/x-mathjax-config">
20+
MathJax.Hub.Config({
21+
extensions: ["tex2jax.js"],
22+
jax: ["input/TeX","output/HTML-CSS"],
23+
});
24+
</script>
25+
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
26+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
27+
</head>
28+
<body>
29+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
30+
<div id="titlearea">
31+
<table cellspacing="0" cellpadding="0">
32+
<tbody>
33+
<tr id="projectrow">
34+
<td id="projectalign">
35+
<div id="projectname">Graph Framework
36+
</div>
37+
</td>
38+
</tr>
39+
</tbody>
40+
</table>
41+
</div>
42+
<!-- end header part -->
43+
<!-- Generated by Doxygen 1.9.8 -->
44+
<script type="text/javascript">
45+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
46+
var searchBox = new SearchBox("searchBox", "search/",'.html');
47+
/* @license-end */
48+
</script>
49+
<script type="text/javascript" src="menudata.js"></script>
50+
<script type="text/javascript" src="menu.js"></script>
51+
<script type="text/javascript">
52+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
53+
$(function() {
54+
initMenu('',true,false,'search.php','Search');
55+
$(document).ready(function() { init_search(); });
56+
});
57+
/* @license-end */
58+
</script>
59+
<div id="main-nav"></div>
60+
</div><!-- top -->
61+
<div id="side-nav" class="ui-resizable side-nav-resizable">
62+
<div id="nav-tree">
63+
<div id="nav-tree-contents">
64+
<div id="nav-sync" class="sync"></div>
65+
</div>
66+
</div>
67+
<div id="splitbar" style="-moz-user-select:none;"
68+
class="ui-resizable-handle">
69+
</div>
70+
</div>
71+
<script type="text/javascript">
72+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
73+
$(document).ready(function(){initNavTree('graph__framework_8hpp.html',''); initResizable(); });
74+
/* @license-end */
75+
</script>
76+
<div id="doc-content">
77+
<!-- window showing the filter options -->
78+
<div id="MSearchSelectWindow"
79+
onmouseover="return searchBox.OnSearchSelectShow()"
80+
onmouseout="return searchBox.OnSearchSelectHide()"
81+
onkeydown="return searchBox.OnSearchSelectKey(event)">
82+
</div>
83+
84+
<!-- iframe showing the search results (closed by default) -->
85+
<div id="MSearchResultsWindow">
86+
<div id="MSearchResults">
87+
<div class="SRPage">
88+
<div id="SRIndex">
89+
<div id="SRResults"></div>
90+
<div class="SRStatus" id="Loading">Loading...</div>
91+
<div class="SRStatus" id="Searching">Searching...</div>
92+
<div class="SRStatus" id="NoMatches">No Matches</div>
93+
</div>
94+
</div>
95+
</div>
96+
</div>
97+
98+
<div class="header">
99+
<div class="headertitle"><div class="title">graph_framework.hpp File Reference</div></div>
100+
</div><!--header-->
101+
<div class="contents">
102+
103+
<p>Single include header for the entire framework.
104+
<a href="#details">More...</a></p>
105+
<div class="textblock"><code>#include &quot;<a class="el" href="absorption_8hpp_source.html">absorption.hpp</a>&quot;</code><br />
106+
<code>#include &quot;<a class="el" href="arithmetic_8hpp_source.html">arithmetic.hpp</a>&quot;</code><br />
107+
<code>#include &quot;<a class="el" href="backend_8hpp_source.html">backend.hpp</a>&quot;</code><br />
108+
<code>#include &quot;<a class="el" href="commandline__parser_8hpp_source.html">commandline_parser.hpp</a>&quot;</code><br />
109+
<code>#include &quot;<a class="el" href="cpu__context_8hpp_source.html">cpu_context.hpp</a>&quot;</code><br />
110+
<code>#include &quot;<a class="el" href="dispersion_8hpp_source.html">dispersion.hpp</a>&quot;</code><br />
111+
<code>#include &quot;<a class="el" href="equilibrium_8hpp_source.html">equilibrium.hpp</a>&quot;</code><br />
112+
<code>#include &quot;<a class="el" href="jit_8hpp_source.html">jit.hpp</a>&quot;</code><br />
113+
<code>#include &quot;<a class="el" href="math_8hpp_source.html">math.hpp</a>&quot;</code><br />
114+
<code>#include &quot;<a class="el" href="newton_8hpp_source.html">newton.hpp</a>&quot;</code><br />
115+
<code>#include &quot;<a class="el" href="node_8hpp_source.html">node.hpp</a>&quot;</code><br />
116+
<code>#include &quot;<a class="el" href="output_8hpp_source.html">output.hpp</a>&quot;</code><br />
117+
<code>#include &quot;<a class="el" href="piecewise_8hpp_source.html">piecewise.hpp</a>&quot;</code><br />
118+
<code>#include &quot;<a class="el" href="random_8hpp_source.html">random.hpp</a>&quot;</code><br />
119+
<code>#include &quot;<a class="el" href="register_8hpp_source.html">register.hpp</a>&quot;</code><br />
120+
<code>#include &quot;<a class="el" href="solver_8hpp_source.html">solver.hpp</a>&quot;</code><br />
121+
<code>#include &quot;<a class="el" href="special__functions_8hpp_source.html">special_functions.hpp</a>&quot;</code><br />
122+
<code>#include &quot;<a class="el" href="timing_8hpp_source.html">timing.hpp</a>&quot;</code><br />
123+
<code>#include &quot;<a class="el" href="trigonometry_8hpp_source.html">trigonometry.hpp</a>&quot;</code><br />
124+
<code>#include &quot;<a class="el" href="vector_8hpp_source.html">vector.hpp</a>&quot;</code><br />
125+
<code>#include &quot;<a class="el" href="workflow_8hpp_source.html">workflow.hpp</a>&quot;</code><br />
126+
</div>
127+
<p><a href="graph__framework_8hpp_source.html">Go to the source code of this file.</a></p>
128+
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
129+
<div class="textblock"><p>Single include header for the entire framework. </p>
130+
</div></div><!-- contents -->
131+
</div><!-- doc-content -->
132+
<!-- start footer part -->
133+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
134+
<ul>
135+
<li class="navelem"><a class="el" href="dir_b94ac65fd6b6212c4d2022b0f23d243a.html">graph_framework</a></li><li class="navelem"><a class="el" href="graph__framework_8hpp.html">graph_framework.hpp</a></li>
136+
<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.9.8 </li>
137+
</ul>
138+
</div>
139+
</body>
140+
</html>

0 commit comments

Comments
 (0)