FYS3150/Project-4
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Cory Balaton
2023-12-04 22:23:30 +01:00
parent d30c98aed2
commit d318491dfe
133 changed files with 7487 additions and 2047 deletions
Download Patch File Download Diff File Expand all files Collapse all files

235
docs/testlib_8hpp.html
View File

@@ -125,6 +125,22 @@ Functions</h2></td></tr>
<tr class="memitem:a39abb7cba0535176ed62aae136d2fcc7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="testlib_8hpp.html#a39abb7cba0535176ed62aae136d2fcc7">details::m_assert</a> (bool expr, std::string expr_str, std::string func, std::string file, int line, std::string msg)</td></tr>
<tr class="memdesc:a39abb7cba0535176ed62aae136d2fcc7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test an expression, confirm that test is ok, or abort execution. <br /></td></tr>
<tr class="separator:a39abb7cba0535176ed62aae136d2fcc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2cbf3a45367e903de6efbdbea3344cea"><td class="memTemplParams" colspan="2">template&lt;class T , class = typename std::enable_if&lt;std::is_arithmetic&lt;T&gt;::value&gt;::type&gt; </td></tr>
<tr class="memitem:a2cbf3a45367e903de6efbdbea3344cea"><td class="memTemplItemLeft" align="right" valign="top">static bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="testlib_8hpp.html#a2cbf3a45367e903de6efbdbea3344cea">testlib::close_to</a> (arma::Mat&lt; T &gt; &amp;a, arma::Mat&lt; T &gt; &amp;b, double tol=1e-8)</td></tr>
<tr class="memdesc:a2cbf3a45367e903de6efbdbea3344cea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test if two armadillo matrices/vectors are close to each other. <br /></td></tr>
<tr class="separator:a2cbf3a45367e903de6efbdbea3344cea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44f47fa3c8654c09712572d75c0ffa7f"><td class="memTemplParams" colspan="2">template&lt;class T , class = typename std::enable_if&lt;std::is_arithmetic&lt;T&gt;::value&gt;::type&gt; </td></tr>
<tr class="memitem:a44f47fa3c8654c09712572d75c0ffa7f"><td class="memTemplItemLeft" align="right" valign="top">static bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="testlib_8hpp.html#a44f47fa3c8654c09712572d75c0ffa7f">testlib::close_to</a> (T a, T b, double tol=1e-8)</td></tr>
<tr class="memdesc:a44f47fa3c8654c09712572d75c0ffa7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test if two numbers are close to each other. <br /></td></tr>
<tr class="separator:a44f47fa3c8654c09712572d75c0ffa7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3db67d8721d2f3cd626526b43186bcf3"><td class="memTemplParams" colspan="2">template&lt;class T , class = typename std::enable_if&lt;std::is_integral&lt;T&gt;::value&gt;::type&gt; </td></tr>
<tr class="memitem:a3db67d8721d2f3cd626526b43186bcf3"><td class="memTemplItemLeft" align="right" valign="top">static bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="testlib_8hpp.html#a3db67d8721d2f3cd626526b43186bcf3">testlib::is_equal</a> (arma::Mat&lt; T &gt; &amp;a, arma::Mat&lt; T &gt; &amp;b)</td></tr>
<tr class="memdesc:a3db67d8721d2f3cd626526b43186bcf3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test if two armadillo matrices/vectors are equal. <br /></td></tr>
<tr class="separator:a3db67d8721d2f3cd626526b43186bcf3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab6585c8aa8c276a3442c67a57c8de6fb"><td class="memTemplParams" colspan="2">template&lt;class T , class = typename std::enable_if&lt;std::is_arithmetic&lt;T&gt;::value&gt;::type&gt; </td></tr>
<tr class="memitem:ab6585c8aa8c276a3442c67a57c8de6fb"><td class="memTemplItemLeft" align="right" valign="top">static bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="testlib_8hpp.html#ab6585c8aa8c276a3442c67a57c8de6fb">testlib::assert_each</a> (std::function&lt; bool(T)&gt; expr, arma::Mat&lt; T &gt; &amp;M)</td></tr>
<tr class="memdesc:ab6585c8aa8c276a3442c67a57c8de6fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test that all elements fulfill the condition. <br /></td></tr>
<tr class="separator:ab6585c8aa8c276a3442c67a57c8de6fb"><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>A small test library. </p>
@@ -133,7 +149,7 @@ Functions</h2></td></tr>
Janita Ovidie Sandtrøen Willumsen (janitaws)</dd></dl>
<dl class="section version"><dt>Version</dt><dd>1.0</dd></dl>
<p>This a small testing library that is tailored for the needs of the project. Anything that is in the details namespace should not be used directly, or else it might cause undefined behavior if not used correctly.</p>
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000005">Bug:</a></b></dt><dd>No known bugs </dd></dl>
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000014">Bug:</a></b></dt><dd>No known bugs </dd></dl>
<p class="definition">Definition in file <a class="el" href="testlib_8hpp_source.html">testlib.hpp</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
@@ -171,6 +187,223 @@ Janita Ovidie Sandtrøen Willumsen (janitaws)</dd></dl>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ab6585c8aa8c276a3442c67a57c8de6fb" name="ab6585c8aa8c276a3442c67a57c8de6fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab6585c8aa8c276a3442c67a57c8de6fb">&#9670;&#160;</a></span>assert_each()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class = typename std::enable_if&lt;std::is_arithmetic&lt;T&gt;::value&gt;::type&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool testlib::assert_each </td>
<td>(</td>
<td class="paramtype">std::function&lt; bool(T)&gt;&#160;</td>
<td class="paramname"><em>expr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">arma::Mat&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>M</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Test that all elements fulfill the condition. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">expr</td><td>The boolean expression to apply to each element </td></tr>
<tr><td class="paramname">M</td><td>The matrix/vector to iterate over</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>bool </dd></dl>
<p class="definition">Definition at line <a class="el" href="testlib_8hpp_source.html#l00130">130</a> of file <a class="el" href="testlib_8hpp_source.html">testlib.hpp</a>.</p>
</div>
</div>
<a id="a2cbf3a45367e903de6efbdbea3344cea" name="a2cbf3a45367e903de6efbdbea3344cea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2cbf3a45367e903de6efbdbea3344cea">&#9670;&#160;</a></span>close_to() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class = typename std::enable_if&lt;std::is_arithmetic&lt;T&gt;::value&gt;::type&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool testlib::close_to </td>
<td>(</td>
<td class="paramtype">arma::Mat&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">arma::Mat&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>b</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>tol</em> = <code>1e-8</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Test if two armadillo matrices/vectors are close to each other. </p>
<p>This function takes in 2 matrices/vectors and checks if they are approximately equal to each other given a tolerance.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>Matrix/vector a </td></tr>
<tr><td class="paramname">b</td><td>Matrix/vector b </td></tr>
<tr><td class="paramname">tol</td><td>The tolerance</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>bool </dd></dl>
<p class="definition">Definition at line <a class="el" href="testlib_8hpp_source.html#l00067">67</a> of file <a class="el" href="testlib_8hpp_source.html">testlib.hpp</a>.</p>
</div>
</div>
<a id="a44f47fa3c8654c09712572d75c0ffa7f" name="a44f47fa3c8654c09712572d75c0ffa7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44f47fa3c8654c09712572d75c0ffa7f">&#9670;&#160;</a></span>close_to() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class = typename std::enable_if&lt;std::is_arithmetic&lt;T&gt;::value&gt;::type&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool testlib::close_to </td>
<td>(</td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>b</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>tol</em> = <code>1e-8</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Test if two numbers are close to each other. </p>
<p>This function takes in 2 matrices/vectors and checks if they are approximately equal to each other given a tolerance.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>Matrix/vector a </td></tr>
<tr><td class="paramname">b</td><td>Matrix/vector b </td></tr>
<tr><td class="paramname">tol</td><td>The tolerance</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>bool </dd></dl>
<p class="definition">Definition at line <a class="el" href="testlib_8hpp_source.html#l00094">94</a> of file <a class="el" href="testlib_8hpp_source.html">testlib.hpp</a>.</p>
</div>
</div>
<a id="a3db67d8721d2f3cd626526b43186bcf3" name="a3db67d8721d2f3cd626526b43186bcf3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3db67d8721d2f3cd626526b43186bcf3">&#9670;&#160;</a></span>is_equal()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class = typename std::enable_if&lt;std::is_integral&lt;T&gt;::value&gt;::type&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool testlib::is_equal </td>
<td>(</td>
<td class="paramtype">arma::Mat&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">arma::Mat&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>b</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Test if two armadillo matrices/vectors are equal. </p>
<p>This function takes in 2 matrices/vectors and checks if they are equal to each other. This should only be used for integral types.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>Matrix/vector a </td></tr>
<tr><td class="paramname">b</td><td>Matrix/vector b</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>bool </dd></dl>
<p class="definition">Definition at line <a class="el" href="testlib_8hpp_source.html#l00111">111</a> of file <a class="el" href="testlib_8hpp_source.html">testlib.hpp</a>.</p>
</div>
</div>
<a id="a39abb7cba0535176ed62aae136d2fcc7" name="a39abb7cba0535176ed62aae136d2fcc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39abb7cba0535176ed62aae136d2fcc7">&#9670;&#160;</a></span>m_assert()</h2>