204 lines
19 KiB
HTML
204 lines
19 KiB
HTML
<!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: src/utils.cpp Source File</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&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&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&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('utils_8cpp_source.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="headertitle"><div class="title">utils.cpp</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="utils_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span> </div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include "<a class="code" href="utils_8hpp.html">utils.hpp</a>"</span></div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="utils_8hpp.html#adfb618b2fdff47ef30a4a2b62c04f384"> 15</a></span>std::string <a class="code hl_function" href="utils_8cpp.html#acd2a9c7a7d5a7fe9163be8c4cc110746">scientific_format</a>(<span class="keywordtype">double</span> d, <span class="keywordtype">int</span> width, <span class="keywordtype">int</span> prec)</div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span>{</div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> std::stringstream ss;</div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> ss << std::setw(width) << std::setprecision(prec) << std::scientific << d;</div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <span class="keywordflow">return</span> ss.str();</div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span>}</div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="utils_8hpp.html#ad54b96a1074f9df4dc892a41d115b72d"> 22</a></span>std::string <a class="code hl_function" href="utils_8cpp.html#acd2a9c7a7d5a7fe9163be8c4cc110746">scientific_format</a>(<span class="keyword">const</span> std::vector<double> &v, <span class="keywordtype">int</span> width, <span class="keywordtype">int</span> prec)</div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span>{</div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> std::stringstream ss;</div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keywordflow">for</span> (<span class="keywordtype">double</span> elem : v) {</div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> ss << <a class="code hl_function" href="utils_8cpp.html#acd2a9c7a7d5a7fe9163be8c4cc110746">scientific_format</a>(elem, width, prec);</div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> }</div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keywordflow">return</span> ss.str();</div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span>}</div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="keyword">static</span> <span class="keywordtype">void</span> print_message(std::string msg)</div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span>{</div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordflow">if</span> (msg.size() > 0) {</div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> std::cout << <span class="stringliteral">"message: "</span> << msg << <span class="stringliteral">"\n\n"</span>;</div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> } <span class="keywordflow">else</span> {</div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> std::cout << <span class="stringliteral">"\n"</span>;</div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> }</div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span>}</div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="utils_8hpp.html#a2cc3a2cdb635bac3c8b02e89d4d6af38"> 40</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="utils_8cpp.html#aff5e07c3c1d321709b0cc38e999f427b">m_assert</a>(<span class="keywordtype">bool</span> expr, std::string expr_str, std::string f, std::string file,</div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordtype">int</span> line, std::string msg)</div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span>{</div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> std::string new_assert(f.size() + (expr ? 4 : 6), <span class="charliteral">'-'</span>);</div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> std::cout << <span class="stringliteral">"\x1B[36m"</span> << new_assert << <span class="stringliteral">"\033[0m\n"</span>;</div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> std::cout << f << <span class="stringliteral">": "</span>;</div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keywordflow">if</span> (expr) {</div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> std::cout << <span class="stringliteral">"\x1B[32mOK\033[0m\n"</span>;</div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> print_message(msg);</div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> } <span class="keywordflow">else</span> {</div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> std::cout << <span class="stringliteral">"\x1B[31mFAIL\033[0m\n"</span>;</div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> print_message(msg);</div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> std::cout << file << <span class="stringliteral">" "</span> << line << <span class="stringliteral">": Assertion \""</span> << expr_str</div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> << <span class="stringliteral">"\" Failed\n\n"</span>;</div>
|
|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> abort();</div>
|
|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> }</div>
|
|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span>}</div>
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"><a class="line" href="utils_8hpp.html#ab3e0cf669bddc59bd53998490ffb68b9"> 58</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="utils_8cpp.html#a6be6f938bcbb235ebb6a2ed9d08411b2">close_to</a>(arma::vec &a, arma::vec &b, <span class="keywordtype">double</span> tol)</div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span>{</div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keywordflow">if</span> (a.n_elem != b.n_elem) {</div>
|
|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> }</div>
|
|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
|
|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i < a.n_elem; i++) {</div>
|
|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keywordflow">if</span> (std::abs(a(i) - b(i)) >= tol) {</div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> }</div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> }</div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
|
|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span>}</div>
|
|
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"><a class="line" href="utils_8hpp.html#a6fdd7217b750aff5b6295ece7cbdeffa"> 72</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="utils_8cpp.html#acf13f4e492199cb7231bfa646dbd08de">mkpath</a>(std::string path, <span class="keywordtype">int</span> mode)</div>
|
|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span>{</div>
|
|
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> std::string cur_dir;</div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> std::string::size_type pos = -1;</div>
|
|
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="keyword">struct </span>stat buf;</div>
|
|
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div>
|
|
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="keywordflow">if</span> (path.back() != <span class="charliteral">'/'</span>) {</div>
|
|
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> path += <span class="charliteral">'/'</span>;</div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> }</div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="keywordflow">while</span> (<span class="keyword">true</span>) {</div>
|
|
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> pos++;</div>
|
|
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> pos = path.find(<span class="charliteral">'/'</span>, pos);</div>
|
|
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keywordflow">if</span> (pos != std::string::npos) {</div>
|
|
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> cur_dir = path.substr(0, pos);</div>
|
|
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <span class="keywordflow">if</span> (mkdir(cur_dir.c_str(), mode) != 0</div>
|
|
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> && stat(cur_dir.c_str(), &buf) != 0) {</div>
|
|
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keywordflow">return</span> -1;</div>
|
|
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> }</div>
|
|
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> } <span class="keywordflow">else</span> {</div>
|
|
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> <span class="keywordflow">break</span>;</div>
|
|
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> }</div>
|
|
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> }</div>
|
|
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <span class="keywordflow">return</span> 0;</div>
|
|
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span>}</div>
|
|
<div class="ttc" id="autils_8cpp_html_a6be6f938bcbb235ebb6a2ed9d08411b2"><div class="ttname"><a href="utils_8cpp.html#a6be6f938bcbb235ebb6a2ed9d08411b2">close_to</a></div><div class="ttdeci">bool close_to(arma::vec &a, arma::vec &b, double tol)</div><div class="ttdoc">Test if two armadillo vectors are close to each other.</div><div class="ttdef"><b>Definition:</b> <a href="utils_8cpp_source.html#l00058">utils.cpp:58</a></div></div>
|
|
<div class="ttc" id="autils_8cpp_html_acd2a9c7a7d5a7fe9163be8c4cc110746"><div class="ttname"><a href="utils_8cpp.html#acd2a9c7a7d5a7fe9163be8c4cc110746">scientific_format</a></div><div class="ttdeci">std::string scientific_format(double d, int width, int prec)</div><div class="ttdoc">Turns a double into a string written in scientific format.</div><div class="ttdef"><b>Definition:</b> <a href="utils_8cpp_source.html#l00015">utils.cpp:15</a></div></div>
|
|
<div class="ttc" id="autils_8cpp_html_acf13f4e492199cb7231bfa646dbd08de"><div class="ttname"><a href="utils_8cpp.html#acf13f4e492199cb7231bfa646dbd08de">mkpath</a></div><div class="ttdeci">bool mkpath(std::string path, int mode)</div><div class="ttdoc">Make path given.</div><div class="ttdef"><b>Definition:</b> <a href="utils_8cpp_source.html#l00072">utils.cpp:72</a></div></div>
|
|
<div class="ttc" id="autils_8cpp_html_aff5e07c3c1d321709b0cc38e999f427b"><div class="ttname"><a href="utils_8cpp.html#aff5e07c3c1d321709b0cc38e999f427b">m_assert</a></div><div class="ttdeci">void m_assert(bool expr, std::string expr_str, std::string f, std::string file, int line, std::string msg)</div><div class="ttdoc">Test an expression, confirm that test is ok, or abort execution.</div><div class="ttdef"><b>Definition:</b> <a href="utils_8cpp_source.html#l00040">utils.cpp:40</a></div></div>
|
|
<div class="ttc" id="autils_8hpp_html"><div class="ttname"><a href="utils_8hpp.html">utils.hpp</a></div><div class="ttdoc">Function prototypes and macros that are useful.</div></div>
|
|
</div><!-- fragment --></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="utils_8cpp.html">utils.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.9.6 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|