FYS3150/Project-3
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
7269429a37
Project-3/docs/typedefs_8hpp.html
Cory 14a6d4ba15
Update docs
2023-10-19 18:37:42 +02:00

234 lines
12 KiB
HTML
Raw Blame History

<!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.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Penning Trap Simulation: include/typedefs.hpp 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>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.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">Penning Trap Simulation
</div>
<div id="projectbrief">Simulate particle behavior inside a Penning Trap</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<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" 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');
$(document).ready(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 */
$(document).ready(function(){initNavTree('typedefs_8hpp.html',''); initResizable(); });
/* @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="#nested-classes">Classes</a> &#124;
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle"><div class="title">typedefs.hpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Useful typedefs for cleaner code.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;armadillo&gt;</code><br />
<code>#include &lt;vector&gt;</code><br />
</div>
<p><a href="typedefs_8hpp_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="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsimulation.html">simulation</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Typedef for PenningTrap::simulation return value. <a href="structsimulation.html#details">More...</a><br /></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="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="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>
<tr class="separator:a784799c37b5e4fb8bf4f6368e004dec6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Useful typedefs for cleaner code. </p>
<dl class="section author"><dt>Author</dt><dd>Cory Alexander Balaton (coryab) </dd>
<dd>
Janita Ovidie Sandtrøen Willumsen (janitaws)</dd></dl>
<dl class="section version"><dt>Version</dt><dd>1.0</dd></dl>
<p>These typedefs make the code more readable and easy to follow along.</p>
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000004">Bug:</a></b></dt><dd>No known bugs </dd></dl>
<p class="definition">Definition in file <a class="el" href="typedefs_8hpp_source.html">typedefs.hpp</a>.</p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="aec69d34220fff45de238b9e01f2686af" name="aec69d34220fff45de238b9e01f2686af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec69d34220fff45de238b9e01f2686af">&#9670;&#160;</a></span>sim_arr</h2>
<div class="memitem">
<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>
</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>
</div>
</div>
<a id="a7c2dfa854274262c4e00e4ef0ab2ce23" name="a7c2dfa854274262c4e00e4ef0ab2ce23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c2dfa854274262c4e00e4ef0ab2ce23">&#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>
</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>
</div>
</div>
<a id="a8502989b1b361725834fc185bd575f66" name="a8502989b1b361725834fc185bd575f66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8502989b1b361725834fc185bd575f66">&#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>
</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>
</div>
</div>
<a id="a9f33f4962c8fb62cc5ccd0e4e039a8df" name="a9f33f4962c8fb62cc5ccd0e4e039a8df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f33f4962c8fb62cc5ccd0e4e039a8df">&#9670;&#160;</a></span>vec_3d</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>
</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>
</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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="typedefs_8hpp.html">typedefs.hpp</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.9.6 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink