355 lines
16 KiB
HTML
355 lines
16 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>2 Dimensional Ising Model: testlib Namespace 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">2 Dimensional Ising Model
|
|
</div>
|
|
<div id="projectbrief">Simulate the change in energy and magnetization in a ferro magnet</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('namespacetestlib.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="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">testlib Namespace Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:a2cbf3a45367e903de6efbdbea3344cea"><td class="memTemplParams" colspan="2">template<class T , class = typename std::enable_if<std::is_arithmetic<T>::value>::type> </td></tr>
|
|
<tr class="memitem:a2cbf3a45367e903de6efbdbea3344cea"><td class="memTemplItemLeft" align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacetestlib.html#a2cbf3a45367e903de6efbdbea3344cea">close_to</a> (arma::Mat< T > &a, arma::Mat< T > &b, double tol=1e-8)</td></tr>
|
|
<tr class="memdesc:a2cbf3a45367e903de6efbdbea3344cea"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:a44f47fa3c8654c09712572d75c0ffa7f"><td class="memTemplParams" colspan="2">template<class T , class = typename std::enable_if<std::is_arithmetic<T>::value>::type> </td></tr>
|
|
<tr class="memitem:a44f47fa3c8654c09712572d75c0ffa7f"><td class="memTemplItemLeft" align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacetestlib.html#a44f47fa3c8654c09712572d75c0ffa7f">close_to</a> (T a, T b, double tol=1e-8)</td></tr>
|
|
<tr class="memdesc:a44f47fa3c8654c09712572d75c0ffa7f"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:a3db67d8721d2f3cd626526b43186bcf3"><td class="memTemplParams" colspan="2">template<class T , class = typename std::enable_if<std::is_integral<T>::value>::type> </td></tr>
|
|
<tr class="memitem:a3db67d8721d2f3cd626526b43186bcf3"><td class="memTemplItemLeft" align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacetestlib.html#a3db67d8721d2f3cd626526b43186bcf3">is_equal</a> (arma::Mat< T > &a, arma::Mat< T > &b)</td></tr>
|
|
<tr class="memdesc:a3db67d8721d2f3cd626526b43186bcf3"><td class="mdescLeft"> </td><td class="mdescRight">Test if two armadillo matrices/vectors are equal. <br /></td></tr>
|
|
<tr class="separator:a3db67d8721d2f3cd626526b43186bcf3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab6585c8aa8c276a3442c67a57c8de6fb"><td class="memTemplParams" colspan="2">template<class T , class = typename std::enable_if<std::is_arithmetic<T>::value>::type> </td></tr>
|
|
<tr class="memitem:ab6585c8aa8c276a3442c67a57c8de6fb"><td class="memTemplItemLeft" align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacetestlib.html#ab6585c8aa8c276a3442c67a57c8de6fb">assert_each</a> (std::function< bool(T)> expr, arma::Mat< T > &M)</td></tr>
|
|
<tr class="memdesc:ab6585c8aa8c276a3442c67a57c8de6fb"><td class="mdescLeft"> </td><td class="mdescRight">Test that all elements fulfill the condition. <br /></td></tr>
|
|
<tr class="separator:ab6585c8aa8c276a3442c67a57c8de6fb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="ab6585c8aa8c276a3442c67a57c8de6fb" name="ab6585c8aa8c276a3442c67a57c8de6fb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab6585c8aa8c276a3442c67a57c8de6fb">◆ </a></span>assert_each()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T , class = typename std::enable_if<std::is_arithmetic<T>::value>::type> </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< bool(T)> </td>
|
|
<td class="paramname"><em>expr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">arma::Mat< T > & </td>
|
|
<td class="paramname"><em>M</em> </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">◆ </a></span>close_to() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T , class = typename std::enable_if<std::is_arithmetic<T>::value>::type> </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< T > & </td>
|
|
<td class="paramname"><em>a</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">arma::Mat< T > & </td>
|
|
<td class="paramname"><em>b</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>tol</em> = <code>1e-8</code> </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">◆ </a></span>close_to() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T , class = typename std::enable_if<std::is_arithmetic<T>::value>::type> </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 </td>
|
|
<td class="paramname"><em>a</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">T </td>
|
|
<td class="paramname"><em>b</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>tol</em> = <code>1e-8</code> </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">◆ </a></span>is_equal()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T , class = typename std::enable_if<std::is_integral<T>::value>::type> </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< T > & </td>
|
|
<td class="paramname"><em>a</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">arma::Mat< T > & </td>
|
|
<td class="paramname"><em>b</em> </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>
|
|
</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="namespacetestlib.html">testlib</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>
|