189 lines
18 KiB
HTML
189 lines
18 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>Simulating the Schrödinger wave equation using the Crank-Nicolson method in 2+1 dimensions: include/testlib.hpp 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">Simulating the Schrödinger wave equation using the Crank-Nicolson method in 2+1 dimensions
|
|
</div>
|
|
<div id="projectbrief">Simulating the Schrödinger wave equation using the Crank-Nicolson method in 2+1 dimensions</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('testlib_8hpp_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">testlib.hpp</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="testlib_8hpp.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="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#ifndef __TESTLIB__</span></div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#define __TESTLIB__</span></div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#include "<a class="code" href="utils_8hpp.html">utils.hpp</a>"</span></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><span class="preprocessor">#include <armadillo></span></div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include <type_traits></span></div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="testlib_8hpp.html#a73d4f21ad937dbc50a0c0538c78fd4f9"> 31</a></span><span class="preprocessor">#define ASSERT(expr, msg) \</span></div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="preprocessor"> details::m_assert(expr, #expr, __METHOD_NAME__, __FILE__, __LINE__, msg)</span></div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="keyword">namespace </span>details {</div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="testlib_8hpp.html#a39abb7cba0535176ed62aae136d2fcc7"> 48</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="testlib_8hpp.html#a39abb7cba0535176ed62aae136d2fcc7">m_assert</a>(<span class="keywordtype">bool</span> expr, std::string expr_str, std::string func,</div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> std::string file, <span class="keywordtype">int</span> line, std::string msg);</div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span>} <span class="comment">// namespace details</span></div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="keyword">namespace </span>testlib {</div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
|
|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="keyword">template</span> <<span class="keyword">class </span>T,</div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="keyword">class </span>= <span class="keyword">typename</span> std::enable_if<std::is_arithmetic<T>::value>::type></div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="testlib_8hpp.html#a2cbf3a45367e903de6efbdbea3344cea"> 67</a></span><span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="testlib_8hpp.html#a2cbf3a45367e903de6efbdbea3344cea">close_to</a>(arma::Mat<T> &a, arma::Mat<T> &b, <span class="keywordtype">double</span> tol = 1e-8)</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">if</span> (a.n_elem != b.n_elem) {</div>
|
|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keywordflow">return</span> <span class="keyword">false</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"> 72</span> </div>
|
|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</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="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keywordflow">if</span> (!<a class="code hl_function" href="testlib_8hpp.html#a2cbf3a45367e903de6efbdbea3344cea">close_to</a>(a(i), b(i))) {</div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
|
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> }</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">return</span> <span class="keyword">true</span>;</div>
|
|
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span>}</div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div>
|
|
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="keyword">template</span> <<span class="keyword">class </span>T,</div>
|
|
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <span class="keyword">class </span>= <span class="keyword">typename</span> std::enable_if<std::is_arithmetic<T>::value>::type></div>
|
|
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"><a class="line" href="testlib_8hpp.html#a44f47fa3c8654c09712572d75c0ffa7f"> 94</a></span><span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="testlib_8hpp.html#a2cbf3a45367e903de6efbdbea3344cea">close_to</a>(T a, T b, <span class="keywordtype">double</span> tol = 1e-8)</div>
|
|
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span>{</div>
|
|
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <span class="keywordflow">return</span> std::fabs(a - b) < tol;</div>
|
|
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span>}</div>
|
|
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> </div>
|
|
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span><span class="keyword">template</span> <<span class="keyword">class </span>T,</div>
|
|
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> <span class="keyword">class </span>= <span class="keyword">typename</span> std::enable_if<std::is_integral<T>::value>::type></div>
|
|
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"><a class="line" href="testlib_8hpp.html#a3db67d8721d2f3cd626526b43186bcf3"> 111</a></span><span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="testlib_8hpp.html#a3db67d8721d2f3cd626526b43186bcf3">is_equal</a>(arma::Mat<T> &a, arma::Mat<T> &b)</div>
|
|
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span>{</div>
|
|
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</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="l00114" name="l00114"></a><span class="lineno"> 114</span> <span class="keywordflow">if</span> (!(a(i) == b(i))) {</div>
|
|
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
|
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> }</div>
|
|
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> }</div>
|
|
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
|
|
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span>}</div>
|
|
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> </div>
|
|
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span><span class="keyword">template</span> <<span class="keyword">class </span>T,</div>
|
|
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> <span class="keyword">class </span>= <span class="keyword">typename</span> std::enable_if<std::is_arithmetic<T>::value>::type></div>
|
|
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"><a class="line" href="testlib_8hpp.html#ab6585c8aa8c276a3442c67a57c8de6fb"> 130</a></span><span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="testlib_8hpp.html#ab6585c8aa8c276a3442c67a57c8de6fb">assert_each</a>(std::function<<span class="keywordtype">bool</span>(T)> expr, arma::Mat<T> &M)</div>
|
|
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span>{</div>
|
|
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i < M.n_elem; i++) {</div>
|
|
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> <span class="keywordflow">if</span> (!expr(M(i))) {</div>
|
|
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
|
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> }</div>
|
|
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> }</div>
|
|
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
|
|
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span>}</div>
|
|
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span>} <span class="comment">// namespace testlib</span></div>
|
|
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span><span class="preprocessor">#endif</span></div>
|
|
<div class="ttc" id="atestlib_8hpp_html_a2cbf3a45367e903de6efbdbea3344cea"><div class="ttname"><a href="testlib_8hpp.html#a2cbf3a45367e903de6efbdbea3344cea">testlib::close_to</a></div><div class="ttdeci">static bool close_to(arma::Mat< T > &a, arma::Mat< T > &b, double tol=1e-8)</div><div class="ttdoc">Test if two armadillo matrices/vectors are close to each other.</div><div class="ttdef"><b>Definition:</b> <a href="testlib_8hpp_source.html#l00067">testlib.hpp:67</a></div></div>
|
|
<div class="ttc" id="atestlib_8hpp_html_a39abb7cba0535176ed62aae136d2fcc7"><div class="ttname"><a href="testlib_8hpp.html#a39abb7cba0535176ed62aae136d2fcc7">details::m_assert</a></div><div class="ttdeci">void m_assert(bool expr, std::string expr_str, std::string func, 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>
|
|
<div class="ttc" id="atestlib_8hpp_html_a3db67d8721d2f3cd626526b43186bcf3"><div class="ttname"><a href="testlib_8hpp.html#a3db67d8721d2f3cd626526b43186bcf3">testlib::is_equal</a></div><div class="ttdeci">static bool is_equal(arma::Mat< T > &a, arma::Mat< T > &b)</div><div class="ttdoc">Test if two armadillo matrices/vectors are equal.</div><div class="ttdef"><b>Definition:</b> <a href="testlib_8hpp_source.html#l00111">testlib.hpp:111</a></div></div>
|
|
<div class="ttc" id="atestlib_8hpp_html_ab6585c8aa8c276a3442c67a57c8de6fb"><div class="ttname"><a href="testlib_8hpp.html#ab6585c8aa8c276a3442c67a57c8de6fb">testlib::assert_each</a></div><div class="ttdeci">static bool assert_each(std::function< bool(T)> expr, arma::Mat< T > &M)</div><div class="ttdoc">Test that all elements fulfill the condition.</div><div class="ttdef"><b>Definition:</b> <a href="testlib_8hpp_source.html#l00130">testlib.hpp:130</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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="testlib_8hpp.html">testlib.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>
|