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

162
docs/classdata__t.html
View File

@@ -105,47 +105,65 @@ $(document).ready(function(){initNavTree('classdata__t.html',''); initResizable(
<div class="headertitle"><div class="title">data_t Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Type to use with the <a class="el" href="classIsingModel.html" title="The Ising model in 2 dimensions.">IsingModel</a> class and montecarlo module.
<a href="classdata__t.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3f2d19ab309e696ba91a2000479bcb83"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdata__t.html#a3f2d19ab309e696ba91a2000479bcb83">data_t</a> (double E, double E2, double M, double M2, double M_abs)</td></tr>
<tr class="memitem:aa2690d3e5d711b4baf3c8f8b9095faf7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdata__t.html#aa2690d3e5d711b4baf3c8f8b9095faf7">data_t</a> ()</td></tr>
<tr class="memdesc:aa2690d3e5d711b4baf3c8f8b9095faf7"><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor with no parameters. <br /></td></tr>
<tr class="separator:aa2690d3e5d711b4baf3c8f8b9095faf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f2d19ab309e696ba91a2000479bcb83"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdata__t.html#a3f2d19ab309e696ba91a2000479bcb83">data_t</a> (double <a class="el" href="classdata__t.html#a6c1a196d96e177b11ca98c61fae35a2e">E</a>, double <a class="el" href="classdata__t.html#abb622f9c6cc5ffb9dddb151d2e202f72">E2</a>, double <a class="el" href="classdata__t.html#ad08d2488bf913c626157471cf6e8a46a">M</a>, double <a class="el" href="classdata__t.html#a71ae3cd4460f2c66239500c11804e70b">M2</a>, double <a class="el" href="classdata__t.html#a586475e0f71322dffda2e75f228ab24b">M_abs</a>)</td></tr>
<tr class="memdesc:a3f2d19ab309e696ba91a2000479bcb83"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor with parameters. <br /></td></tr>
<tr class="separator:a3f2d19ab309e696ba91a2000479bcb83"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a429a11c53ee7fe08f6a4e75db524521d"><td class="memTemplParams" colspan="2">template&lt;class T &gt; </td></tr>
<tr class="memitem:a429a11c53ee7fe08f6a4e75db524521d"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classdata__t.html">data_t</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdata__t.html#a429a11c53ee7fe08f6a4e75db524521d">operator/</a> (T num)</td></tr>
<tr class="memdesc:a429a11c53ee7fe08f6a4e75db524521d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overload of the division operator. <br /></td></tr>
<tr class="separator:a429a11c53ee7fe08f6a4e75db524521d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88da5be78439fbdecfa473ec007dffd8"><td class="memTemplParams" colspan="2">template&lt;class T &gt; </td></tr>
<tr class="memitem:a88da5be78439fbdecfa473ec007dffd8"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classdata__t.html">data_t</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdata__t.html#a88da5be78439fbdecfa473ec007dffd8">operator/=</a> (T num)</td></tr>
<tr class="memdesc:a88da5be78439fbdecfa473ec007dffd8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overload of the division equals operator. <br /></td></tr>
<tr class="separator:a88da5be78439fbdecfa473ec007dffd8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7954efc97086ea50e10c33113b203085"><td class="memTemplParams" colspan="2">template&lt;class T &gt; </td></tr>
<tr class="memitem:a7954efc97086ea50e10c33113b203085"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classdata__t.html">data_t</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdata__t.html#a7954efc97086ea50e10c33113b203085">operator*</a> (T num)</td></tr>
<tr class="memdesc:a7954efc97086ea50e10c33113b203085"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overload of the multiply operator. <br /></td></tr>
<tr class="separator:a7954efc97086ea50e10c33113b203085"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ddf3a7372730ef2393aee8bbcb34992"><td class="memTemplParams" colspan="2">template&lt;class T &gt; </td></tr>
<tr class="memitem:a6ddf3a7372730ef2393aee8bbcb34992"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classdata__t.html">data_t</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdata__t.html#a6ddf3a7372730ef2393aee8bbcb34992">operator*=</a> (T num)</td></tr>
<tr class="memdesc:a6ddf3a7372730ef2393aee8bbcb34992"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overload of the multiply equals operator. <br /></td></tr>
<tr class="separator:a6ddf3a7372730ef2393aee8bbcb34992"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13bc1d73eadeb39c507e89f5872d726f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdata__t.html">data_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdata__t.html#a13bc1d73eadeb39c507e89f5872d726f">operator+</a> (const <a class="el" href="classdata__t.html">data_t</a> &amp;b)</td></tr>
<tr class="memdesc:a13bc1d73eadeb39c507e89f5872d726f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overload of the addition operator. <br /></td></tr>
<tr class="separator:a13bc1d73eadeb39c507e89f5872d726f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6cb96b4ff750ab29041038ca53f307cb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdata__t.html">data_t</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdata__t.html#a6cb96b4ff750ab29041038ca53f307cb">operator+=</a> (const <a class="el" href="classdata__t.html">data_t</a> &amp;b)</td></tr>
<tr class="memdesc:a6cb96b4ff750ab29041038ca53f307cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overload of the addition equals operator. <br /></td></tr>
<tr class="separator:a6cb96b4ff750ab29041038ca53f307cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2d3c039ae62418d03f3fe4d02c94416"><td class="memTemplParams" colspan="2">template&lt;class T &gt; </td></tr>
<tr class="memitem:ae2d3c039ae62418d03f3fe4d02c94416"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdata__t.html#ae2d3c039ae62418d03f3fe4d02c94416">operator=</a> (T num)</td></tr>
<tr class="separator:ae2d3c039ae62418d03f3fe4d02c94416"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a6c1a196d96e177b11ca98c61fae35a2e"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdata__t.html#a6c1a196d96e177b11ca98c61fae35a2e">E</a></td></tr>
<tr class="memdesc:a6c1a196d96e177b11ca98c61fae35a2e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Energy. <br /></td></tr>
<tr class="separator:a6c1a196d96e177b11ca98c61fae35a2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad08d2488bf913c626157471cf6e8a46a"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdata__t.html#ad08d2488bf913c626157471cf6e8a46a">M</a></td></tr>
<tr class="memdesc:ad08d2488bf913c626157471cf6e8a46a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Magnetization. <br /></td></tr>
<tr class="separator:ad08d2488bf913c626157471cf6e8a46a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb622f9c6cc5ffb9dddb151d2e202f72"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdata__t.html#abb622f9c6cc5ffb9dddb151d2e202f72">E2</a></td></tr>
<tr class="memdesc:abb622f9c6cc5ffb9dddb151d2e202f72"><td class="mdescLeft">&#160;</td><td class="mdescRight">Energy squared. <br /></td></tr>
<tr class="separator:abb622f9c6cc5ffb9dddb151d2e202f72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71ae3cd4460f2c66239500c11804e70b"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdata__t.html#a71ae3cd4460f2c66239500c11804e70b">M2</a></td></tr>
<tr class="memdesc:a71ae3cd4460f2c66239500c11804e70b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Magnetization squared. <br /></td></tr>
<tr class="separator:a71ae3cd4460f2c66239500c11804e70b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a586475e0f71322dffda2e75f228ab24b"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdata__t.html#a586475e0f71322dffda2e75f228ab24b">M_abs</a></td></tr>
<tr class="memdesc:a586475e0f71322dffda2e75f228ab24b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Absolute Magnetization. <br /></td></tr>
<tr class="separator:a586475e0f71322dffda2e75f228ab24b"><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 class="definition">Definition at line <a class="el" href="data__type_8hpp_source.html#l00018">18</a> of file <a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>.</p>
<div class="textblock"><p>Type to use with the <a class="el" href="classIsingModel.html" title="The Ising model in 2 dimensions.">IsingModel</a> class and montecarlo module. </p>
<p class="definition">Definition at line <a class="el" href="data__type_8hpp_source.html#l00019">19</a> of file <a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aa2690d3e5d711b4baf3c8f8b9095faf7" name="aa2690d3e5d711b4baf3c8f8b9095faf7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2690d3e5d711b4baf3c8f8b9095faf7">&#9670;&#160;</a></span>data_t() <span class="overload">[1/2]</span></h2>
@@ -170,7 +188,9 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="data__type_8hpp_source.html#l00022">22</a> of file <a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>.</p>
<p>constructor with no parameters. </p>
<p class="definition">Definition at line <a class="el" href="data__type_8hpp_source.html#l00029">29</a> of file <a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>.</p>
</div>
</div>
@@ -226,7 +246,19 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="data__type_8hpp_source.html#l00031">31</a> of file <a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>.</p>
<p>Constructor with parameters. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">E</td><td>Initial energy </td></tr>
<tr><td class="paramname">E2</td><td>Initial energy squared </td></tr>
<tr><td class="paramname">M</td><td>Initial magnetization </td></tr>
<tr><td class="paramname">M2</td><td>Initial magnetization squared </td></tr>
<tr><td class="paramname">M_abs</td><td>Initial absolute magnetization </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="data__type_8hpp_source.html#l00045">45</a> of file <a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>.</p>
</div>
</div>
@@ -257,7 +289,16 @@ template&lt;class T &gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="data__type_8hpp_source.html#l00063">63</a> of file <a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>.</p>
<p>Overload of the multiply operator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">num</td><td>The number to multiply each field by.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classdata__t.html" title="Type to use with the IsingModel class and montecarlo module.">data_t</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="data__type_8hpp_source.html#l00096">96</a> of file <a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>.</p>
</div>
</div>
@@ -287,7 +328,16 @@ template&lt;class T &gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="data__type_8hpp_source.html#l00075">75</a> of file <a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>.</p>
<p>Overload of the multiply equals operator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">num</td><td>The number to multiply each field by.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classdata__t.html" title="Type to use with the IsingModel class and montecarlo module.">data_t</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="data__type_8hpp_source.html#l00114">114</a> of file <a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>.</p>
</div>
</div>
@@ -315,7 +365,16 @@ template&lt;class T &gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="data__type_8hpp_source.html#l00086">86</a> of file <a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>.</p>
<p>Overload of the addition operator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">b</td><td>The <a class="el" href="classdata__t.html" title="Type to use with the IsingModel class and montecarlo module.">data_t</a> field to add.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classdata__t.html" title="Type to use with the IsingModel class and montecarlo module.">data_t</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="data__type_8hpp_source.html#l00132">132</a> of file <a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>.</p>
</div>
</div>
@@ -343,7 +402,16 @@ template&lt;class T &gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="data__type_8hpp_source.html#l00098">98</a> of file <a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>.</p>
<p>Overload of the addition equals operator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">b</td><td>The <a class="el" href="classdata__t.html" title="Type to use with the IsingModel class and montecarlo module.">data_t</a> field to add.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classdata__t.html" title="Type to use with the IsingModel class and montecarlo module.">data_t</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="data__type_8hpp_source.html#l00150">150</a> of file <a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>.</p>
</div>
</div>
@@ -373,7 +441,16 @@ template&lt;class T &gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="data__type_8hpp_source.html#l00040">40</a> of file <a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>.</p>
<p>Overload of the division operator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">num</td><td>The number to divide each field by.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classdata__t.html" title="Type to use with the IsingModel class and montecarlo module.">data_t</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="data__type_8hpp_source.html#l00060">60</a> of file <a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>.</p>
</div>
</div>
@@ -403,37 +480,16 @@ template&lt;class T &gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="data__type_8hpp_source.html#l00052">52</a> of file <a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>.</p>
<p>Overload of the division equals operator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">num</td><td>The number to divide each field by.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classdata__t.html" title="Type to use with the IsingModel class and montecarlo module.">data_t</a> </dd></dl>
</div>
</div>
<a id="ae2d3c039ae62418d03f3fe4d02c94416" name="ae2d3c039ae62418d03f3fe4d02c94416"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2d3c039ae62418d03f3fe4d02c94416">&#9670;&#160;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void data_t::operator= </td>
<td>(</td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>num</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="data__type_8hpp_source.html#l00109">109</a> of file <a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="data__type_8hpp_source.html#l00079">79</a> of file <a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>.</p>
</div>
</div>
@@ -450,7 +506,9 @@ template&lt;class T &gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="data__type_8hpp_source.html#l00020">20</a> of file <a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>.</p>
<p>Energy. </p>
<p class="definition">Definition at line <a class="el" href="data__type_8hpp_source.html#l00021">21</a> of file <a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>.</p>
</div>
</div>
@@ -466,7 +524,9 @@ template&lt;class T &gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="data__type_8hpp_source.html#l00020">20</a> of file <a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>.</p>
<p>Energy squared. </p>
<p class="definition">Definition at line <a class="el" href="data__type_8hpp_source.html#l00023">23</a> of file <a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>.</p>
</div>
</div>
@@ -482,7 +542,9 @@ template&lt;class T &gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="data__type_8hpp_source.html#l00020">20</a> of file <a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>.</p>
<p>Magnetization. </p>
<p class="definition">Definition at line <a class="el" href="data__type_8hpp_source.html#l00022">22</a> of file <a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>.</p>
</div>
</div>
@@ -498,7 +560,9 @@ template&lt;class T &gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="data__type_8hpp_source.html#l00020">20</a> of file <a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>.</p>
<p>Magnetization squared. </p>
<p class="definition">Definition at line <a class="el" href="data__type_8hpp_source.html#l00024">24</a> of file <a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>.</p>
</div>
</div>
@@ -514,7 +578,9 @@ template&lt;class T &gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="data__type_8hpp_source.html#l00020">20</a> of file <a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>.</p>
<p>Absolute Magnetization. </p>
<p class="definition">Definition at line <a class="el" href="data__type_8hpp_source.html#l00025">25</a> of file <a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>.</p>
</div>
</div>