Update docs

This commit is contained in:
2023-10-23 12:43:32 +02:00
parent 1ae665e7e7
commit d2824d7c1d
76 changed files with 2046 additions and 1529 deletions

View File

@@ -120,18 +120,18 @@ Classes</h2></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a7c2dfa854274262c4e00e4ef0ab2ce23"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; arma::vec::fixed&lt; 3 &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="typedefs_8hpp.html#a7c2dfa854274262c4e00e4ef0ab2ce23">sim_cols</a></td></tr>
<tr class="memdesc:a7c2dfa854274262c4e00e4ef0ab2ce23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Typedef for the column of the result vector from simulating particles. <br /></td></tr>
<tr class="separator:a7c2dfa854274262c4e00e4ef0ab2ce23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8502989b1b361725834fc185bd575f66"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; arma::vec::fixed&lt; 3 &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="typedefs_8hpp.html#a8502989b1b361725834fc185bd575f66">sim_rows</a></td></tr>
<tr class="memdesc:a8502989b1b361725834fc185bd575f66"><td class="mdescLeft">&#160;</td><td class="mdescRight">Typedef for the row of the result vector from simulating particles. <br /></td></tr>
<tr class="separator:a8502989b1b361725834fc185bd575f66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec69d34220fff45de238b9e01f2686af"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; <a class="el" href="typedefs_8hpp.html#a7c2dfa854274262c4e00e4ef0ab2ce23">sim_cols</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="typedefs_8hpp.html#aec69d34220fff45de238b9e01f2686af">sim_arr</a></td></tr>
<tr class="memitem:a3bdfb73a02f88ae32b6128ef747c4aea"><td class="memItemLeft" align="right" valign="top">typedef arma::vec::fixed&lt; 3 &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="typedefs_8hpp.html#a3bdfb73a02f88ae32b6128ef747c4aea">vec3</a></td></tr>
<tr class="memdesc:a3bdfb73a02f88ae32b6128ef747c4aea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Typedef for a fixed 3d arma vector. <br /></td></tr>
<tr class="separator:a3bdfb73a02f88ae32b6128ef747c4aea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a46482a2697556c00556c9d73f461784f"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; <a class="el" href="typedefs_8hpp.html#a3bdfb73a02f88ae32b6128ef747c4aea">vec3</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="typedefs_8hpp.html#a46482a2697556c00556c9d73f461784f">sim_cols</a></td></tr>
<tr class="memdesc:a46482a2697556c00556c9d73f461784f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Typedef for the column of the result vector from simulating particles. <br /></td></tr>
<tr class="separator:a46482a2697556c00556c9d73f461784f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33418f31f28663b8414c8f7182998c22"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; <a class="el" href="typedefs_8hpp.html#a3bdfb73a02f88ae32b6128ef747c4aea">vec3</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="typedefs_8hpp.html#a33418f31f28663b8414c8f7182998c22">sim_rows</a></td></tr>
<tr class="memdesc:a33418f31f28663b8414c8f7182998c22"><td class="mdescLeft">&#160;</td><td class="mdescRight">Typedef for the row of the result vector from simulating particles. <br /></td></tr>
<tr class="separator:a33418f31f28663b8414c8f7182998c22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec69d34220fff45de238b9e01f2686af"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; <a class="el" href="typedefs_8hpp.html#a46482a2697556c00556c9d73f461784f">sim_cols</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="typedefs_8hpp.html#aec69d34220fff45de238b9e01f2686af">sim_arr</a></td></tr>
<tr class="memdesc:aec69d34220fff45de238b9e01f2686af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Typedef for the result of the simulate method. <br /></td></tr>
<tr class="separator:aec69d34220fff45de238b9e01f2686af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f33f4962c8fb62cc5ccd0e4e039a8df"><td class="memItemLeft" align="right" valign="top">typedef arma::vec::fixed&lt; 3 &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="typedefs_8hpp.html#a9f33f4962c8fb62cc5ccd0e4e039a8df">vec_3d</a></td></tr>
<tr class="memdesc:a9f33f4962c8fb62cc5ccd0e4e039a8df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Typedef for a fixed 3d arma vector. <br /></td></tr>
<tr class="separator:a9f33f4962c8fb62cc5ccd0e4e039a8df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a784799c37b5e4fb8bf4f6368e004dec6"><td class="memItemLeft" align="right" valign="top"><a id="a784799c37b5e4fb8bf4f6368e004dec6" name="a784799c37b5e4fb8bf4f6368e004dec6"></a>
typedef struct <a class="el" href="structsimulation.html">simulation</a>&#160;</td><td class="memItemRight" valign="bottom"><b>simulation_t</b></td></tr>
<tr class="memdesc:a784799c37b5e4fb8bf4f6368e004dec6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Typedef for PenningTrap::simulation return value. <br /></td></tr>
@@ -155,68 +155,68 @@ Janita Ovidie Sandtrøen Willumsen (janitaws)</dd></dl>
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::vector&lt;<a class="el" href="typedefs_8hpp.html#a7c2dfa854274262c4e00e4ef0ab2ce23">sim_cols</a>&gt; <a class="el" href="typedefs_8hpp.html#aec69d34220fff45de238b9e01f2686af">sim_arr</a></td>
<td class="memname">typedef std::vector&lt;<a class="el" href="typedefs_8hpp.html#a46482a2697556c00556c9d73f461784f">sim_cols</a>&gt; <a class="el" href="typedefs_8hpp.html#aec69d34220fff45de238b9e01f2686af">sim_arr</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Typedef for the result of the simulate method. </p>
<p class="definition">Definition at line <a class="el" href="typedefs_8hpp_source.html#l00032">32</a> of file <a class="el" href="typedefs_8hpp_source.html">typedefs.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="typedefs_8hpp_source.html#l00036">36</a> of file <a class="el" href="typedefs_8hpp_source.html">typedefs.hpp</a>.</p>
</div>
</div>
<a id="a7c2dfa854274262c4e00e4ef0ab2ce23" name="a7c2dfa854274262c4e00e4ef0ab2ce23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c2dfa854274262c4e00e4ef0ab2ce23">&#9670;&#160;</a></span>sim_cols</h2>
<a id="a46482a2697556c00556c9d73f461784f" name="a46482a2697556c00556c9d73f461784f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46482a2697556c00556c9d73f461784f">&#9670;&#160;</a></span>sim_cols</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::vector&lt;arma::vec::fixed&lt;3&gt; &gt; <a class="el" href="typedefs_8hpp.html#a7c2dfa854274262c4e00e4ef0ab2ce23">sim_cols</a></td>
<td class="memname">typedef std::vector&lt;<a class="el" href="typedefs_8hpp.html#a3bdfb73a02f88ae32b6128ef747c4aea">vec3</a>&gt; <a class="el" href="typedefs_8hpp.html#a46482a2697556c00556c9d73f461784f">sim_cols</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Typedef for the column of the result vector from simulating particles. </p>
<p class="definition">Definition at line <a class="el" href="typedefs_8hpp_source.html#l00024">24</a> of file <a class="el" href="typedefs_8hpp_source.html">typedefs.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="typedefs_8hpp_source.html#l00028">28</a> of file <a class="el" href="typedefs_8hpp_source.html">typedefs.hpp</a>.</p>
</div>
</div>
<a id="a8502989b1b361725834fc185bd575f66" name="a8502989b1b361725834fc185bd575f66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8502989b1b361725834fc185bd575f66">&#9670;&#160;</a></span>sim_rows</h2>
<a id="a33418f31f28663b8414c8f7182998c22" name="a33418f31f28663b8414c8f7182998c22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33418f31f28663b8414c8f7182998c22">&#9670;&#160;</a></span>sim_rows</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::vector&lt;arma::vec::fixed&lt;3&gt; &gt; <a class="el" href="typedefs_8hpp.html#a8502989b1b361725834fc185bd575f66">sim_rows</a></td>
<td class="memname">typedef std::vector&lt;<a class="el" href="typedefs_8hpp.html#a3bdfb73a02f88ae32b6128ef747c4aea">vec3</a>&gt; <a class="el" href="typedefs_8hpp.html#a33418f31f28663b8414c8f7182998c22">sim_rows</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Typedef for the row of the result vector from simulating particles. </p>
<p class="definition">Definition at line <a class="el" href="typedefs_8hpp_source.html#l00028">28</a> of file <a class="el" href="typedefs_8hpp_source.html">typedefs.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="typedefs_8hpp_source.html#l00032">32</a> of file <a class="el" href="typedefs_8hpp_source.html">typedefs.hpp</a>.</p>
</div>
</div>
<a id="a9f33f4962c8fb62cc5ccd0e4e039a8df" name="a9f33f4962c8fb62cc5ccd0e4e039a8df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f33f4962c8fb62cc5ccd0e4e039a8df">&#9670;&#160;</a></span>vec_3d</h2>
<a id="a3bdfb73a02f88ae32b6128ef747c4aea" name="a3bdfb73a02f88ae32b6128ef747c4aea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3bdfb73a02f88ae32b6128ef747c4aea">&#9670;&#160;</a></span>vec3</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef arma::vec::fixed&lt;3&gt; <a class="el" href="typedefs_8hpp.html#a9f33f4962c8fb62cc5ccd0e4e039a8df">vec_3d</a></td>
<td class="memname">typedef arma::vec::fixed&lt;3&gt; <a class="el" href="typedefs_8hpp.html#a3bdfb73a02f88ae32b6128ef747c4aea">vec3</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Typedef for a fixed 3d arma vector. </p>
<p class="definition">Definition at line <a class="el" href="typedefs_8hpp_source.html#l00036">36</a> of file <a class="el" href="typedefs_8hpp_source.html">typedefs.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="typedefs_8hpp_source.html#l00023">23</a> of file <a class="el" href="typedefs_8hpp_source.html">typedefs.hpp</a>.</p>
</div>
</div>