Update docs

This commit is contained in:
2023-12-04 22:23:30 +01:00
parent d30c98aed2
commit d318491dfe
133 changed files with 7487 additions and 2047 deletions

View File

@@ -124,29 +124,29 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:a56559d68dc9aaff1976d84b157f43488"><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="classIsingModel.html#a56559d68dc9aaff1976d84b157f43488">Metropolis</a> ()</td></tr>
<tr class="memdesc:a56559d68dc9aaff1976d84b157f43488"><td class="mdescLeft">&#160;</td><td class="mdescRight">The Metropolis algorithm. <br /></td></tr>
<tr class="separator:a56559d68dc9aaff1976d84b157f43488"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa0787d964b004a17869811a5e947ff5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#aaa0787d964b004a17869811a5e947ff5">get_E</a> ()</td></tr>
<tr class="memdesc:aaa0787d964b004a17869811a5e947ff5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current energy. <br /></td></tr>
<tr class="separator:aaa0787d964b004a17869811a5e947ff5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5701496e6483bc4668c486d6d3af625"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#aa5701496e6483bc4668c486d6d3af625">get_M</a> ()</td></tr>
<tr class="memdesc:aa5701496e6483bc4668c486d6d3af625"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current magnetization. <br /></td></tr>
<tr class="separator:aa5701496e6483bc4668c486d6d3af625"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:aaedc25b7284e04849269f31291590bf5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#aaedc25b7284e04849269f31291590bf5">initialize_engine</a> ()</td></tr>
<tr class="memdesc:aaedc25b7284e04849269f31291590bf5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the RNG. <br /></td></tr>
<tr class="separator:aaedc25b7284e04849269f31291590bf5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34a4710949b4a70f3e37ca223aefcf8a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#a34a4710949b4a70f3e37ca223aefcf8a">initialize_lattice</a> ()</td></tr>
<tr class="memdesc:a34a4710949b4a70f3e37ca223aefcf8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the lattice with a random distribution of 1s and -1s. <br /></td></tr>
<tr class="separator:a34a4710949b4a70f3e37ca223aefcf8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc86effd6889bea199a3d70a9f38dc78"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#acc86effd6889bea199a3d70a9f38dc78">initialize_lattice</a> (int val)</td></tr>
<tr class="memdesc:acc86effd6889bea199a3d70a9f38dc78"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the lattice with a specific value. <br /></td></tr>
<tr class="separator:acc86effd6889bea199a3d70a9f38dc78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6776109105051597c275670dabd0054a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#a6776109105051597c275670dabd0054a">initialize_neighbors</a> ()</td></tr>
<tr class="memdesc:a6776109105051597c275670dabd0054a"><td class="mdescLeft">&#160;</td><td class="mdescRight">initialize the neighbors matrix. <br /></td></tr>
<tr class="separator:a6776109105051597c275670dabd0054a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff9a1201933fd5408845a1447e4895b4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#aff9a1201933fd5408845a1447e4895b4">initialize_energy_diff</a> ()</td></tr>
<tr class="memdesc:aff9a1201933fd5408845a1447e4895b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the hashmap with the correct values. <br /></td></tr>
<tr class="memdesc:aff9a1201933fd5408845a1447e4895b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the energy_diff array with the correct values. <br /></td></tr>
<tr class="separator:aff9a1201933fd5408845a1447e4895b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a926cf4964d190d2ce23e5a17201787a4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#a926cf4964d190d2ce23e5a17201787a4">initialize_magnetization</a> ()</td></tr>
<tr class="memdesc:a926cf4964d190d2ce23e5a17201787a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the magnetization. <br /></td></tr>
<tr class="memdesc:a926cf4964d190d2ce23e5a17201787a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the magnetization of the system. <br /></td></tr>
<tr class="separator:a926cf4964d190d2ce23e5a17201787a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a59fced38c695e2fa647f53be81b9d2a1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#a59fced38c695e2fa647f53be81b9d2a1">initialize_energy</a> ()</td></tr>
<tr class="memdesc:a59fced38c695e2fa647f53be81b9d2a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the energy. <br /></td></tr>
<tr class="memdesc:a59fced38c695e2fa647f53be81b9d2a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the energy of the system. <br /></td></tr>
<tr class="separator:a59fced38c695e2fa647f53be81b9d2a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf281f6f5ed02911ca6ab07004449864"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#acf281f6f5ed02911ca6ab07004449864">IsingModel</a> ()</td></tr>
<tr class="memdesc:acf281f6f5ed02911ca6ab07004449864"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor used for testing. <br /></td></tr>
@@ -160,32 +160,36 @@ Private Attributes</h2></td></tr>
<tr class="memitem:a94093aaf30facca62737f2ac381fdbcd"><td class="memItemLeft" align="right" valign="top">arma::Mat&lt; int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#a94093aaf30facca62737f2ac381fdbcd">neighbors</a></td></tr>
<tr class="memdesc:a94093aaf30facca62737f2ac381fdbcd"><td class="mdescLeft">&#160;</td><td class="mdescRight">\( L \times 2 \) matrix with the neighbors of each element \( x_i \). <br /></td></tr>
<tr class="separator:a94093aaf30facca62737f2ac381fdbcd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a4ceb1bb2593dbd20c51ed04100cbcd"><td class="memItemLeft" align="right" valign="top">std::unordered_map&lt; int, double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#a1a4ceb1bb2593dbd20c51ed04100cbcd">energy_diff</a></td></tr>
<tr class="memdesc:a1a4ceb1bb2593dbd20c51ed04100cbcd"><td class="mdescLeft">&#160;</td><td class="mdescRight">A hash map containing all possible energy changes. <br /></td></tr>
<tr class="separator:a1a4ceb1bb2593dbd20c51ed04100cbcd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7112dd6433b1bb9512150cbdc1a0b77e"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#a7112dd6433b1bb9512150cbdc1a0b77e">energy_diff</a> [17]</td></tr>
<tr class="memdesc:a7112dd6433b1bb9512150cbdc1a0b77e"><td class="mdescLeft">&#160;</td><td class="mdescRight">An array containing all possible energy differences. <br /></td></tr>
<tr class="separator:a7112dd6433b1bb9512150cbdc1a0b77e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20fc4c0c99d8a119f70a1614784d4e5c"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#a20fc4c0c99d8a119f70a1614784d4e5c">T</a></td></tr>
<tr class="memdesc:a20fc4c0c99d8a119f70a1614784d4e5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The temperature of the model. <br /></td></tr>
<tr class="separator:a20fc4c0c99d8a119f70a1614784d4e5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b8ac43baefeb386186266d5aa4de348"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#a2b8ac43baefeb386186266d5aa4de348">L</a></td></tr>
<tr class="memdesc:a2b8ac43baefeb386186266d5aa4de348"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of the lattice. <br /></td></tr>
<tr class="separator:a2b8ac43baefeb386186266d5aa4de348"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9f872ca2054992161d53306119979dd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#ae9f872ca2054992161d53306119979dd">E</a></td></tr>
<tr class="memdesc:ae9f872ca2054992161d53306119979dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">The current energy state. unit: \( J \). <br /></td></tr>
<tr class="separator:ae9f872ca2054992161d53306119979dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d373a61baca6b0faa607bb12d82cc47"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#a0d373a61baca6b0faa607bb12d82cc47">M</a></td></tr>
<tr class="memdesc:a0d373a61baca6b0faa607bb12d82cc47"><td class="mdescLeft">&#160;</td><td class="mdescRight">The current magnetic strength. unit: Unitless. <br /></td></tr>
<tr class="separator:a0d373a61baca6b0faa607bb12d82cc47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c8a2a4331c7e60c3e1350c0cf8300b9"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#a1c8a2a4331c7e60c3e1350c0cf8300b9">E</a></td></tr>
<tr class="memdesc:a1c8a2a4331c7e60c3e1350c0cf8300b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">The current energy state. unit: \( J \). <br /></td></tr>
<tr class="separator:a1c8a2a4331c7e60c3e1350c0cf8300b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef7232b28df08e064ef58eb5ef32f738"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#aef7232b28df08e064ef58eb5ef32f738">M</a></td></tr>
<tr class="memdesc:aef7232b28df08e064ef58eb5ef32f738"><td class="mdescLeft">&#160;</td><td class="mdescRight">The current magnetic strength. unit: Unitless. <br /></td></tr>
<tr class="separator:aef7232b28df08e064ef58eb5ef32f738"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1bbe0cb10abee98058e7b45b22b9cd0a"><td class="memItemLeft" align="right" valign="top">std::mt19937&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#a1bbe0cb10abee98058e7b45b22b9cd0a">engine</a></td></tr>
<tr class="memdesc:a1bbe0cb10abee98058e7b45b22b9cd0a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The RNG that is used for the Metropolis algorithm. <br /></td></tr>
<tr class="separator:a1bbe0cb10abee98058e7b45b22b9cd0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a2b1cf104e0bda1fce78ed366e1ec7287"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#a2b1cf104e0bda1fce78ed366e1ec7287">IsingModelTest</a></td></tr>
<tr class="memdesc:a2b1cf104e0bda1fce78ed366e1ec7287"><td class="mdescLeft">&#160;</td><td class="mdescRight">Give access to private members to the test class <a class="el" href="classIsingModelTest.html" title="Test class for the Ising model.">IsingModelTest</a>. <br /></td></tr>
<tr class="separator:a2b1cf104e0bda1fce78ed366e1ec7287"><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>The Ising model in 2 dimensions. </p>
<p>None of the methods are parallelized, as there is very little benefit in doing so. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8hpp_source.html#l00037">37</a> of file <a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8hpp_source.html#l00036">36</a> of file <a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="acf281f6f5ed02911ca6ab07004449864" name="acf281f6f5ed02911ca6ab07004449864"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf281f6f5ed02911ca6ab07004449864">&#9670;&#160;</a></span>IsingModel() <span class="overload">[1/3]</span></h2>
@@ -212,7 +216,7 @@ Friends</h2></td></tr>
<p>Constructor used for testing. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00017">17</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00014">14</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
</div>
</div>
@@ -251,7 +255,7 @@ Friends</h2></td></tr>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00021">21</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00019">19</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
</div>
</div>
@@ -297,55 +301,11 @@ Friends</h2></td></tr>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00032">32</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00031">31</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aaa0787d964b004a17869811a5e947ff5" name="aaa0787d964b004a17869811a5e947ff5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa0787d964b004a17869811a5e947ff5">&#9670;&#160;</a></span>get_E()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int IsingModel::get_E </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current energy. </p>
<dl class="section return"><dt>Returns</dt><dd>double </dd></dl>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00135">135</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
</div>
</div>
<a id="aa5701496e6483bc4668c486d6d3af625" name="aa5701496e6483bc4668c486d6d3af625"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5701496e6483bc4668c486d6d3af625">&#9670;&#160;</a></span>get_M()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int IsingModel::get_M </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current magnetization. </p>
<dl class="section return"><dt>Returns</dt><dd>double </dd></dl>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00140">140</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
</div>
</div>
<a id="a59fced38c695e2fa647f53be81b9d2a1" name="a59fced38c695e2fa647f53be81b9d2a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59fced38c695e2fa647f53be81b9d2a1">&#9670;&#160;</a></span>initialize_energy()</h2>
@@ -369,9 +329,9 @@ Friends</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Initialize the energy. </p>
<p>Initialize the energy of the system. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00082">82</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00096">96</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
</div>
</div>
@@ -398,14 +358,43 @@ Friends</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Initialize the hashmap with the correct values. </p>
<p>Initialize the energy_diff array with the correct values. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00067">67</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00081">81</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
</div>
</div>
<a id="aaedc25b7284e04849269f31291590bf5" name="aaedc25b7284e04849269f31291590bf5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaedc25b7284e04849269f31291590bf5">&#9670;&#160;</a></span>initialize_engine()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void IsingModel::initialize_engine </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the RNG. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00043">43</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
</div>
</div>
<a id="a34a4710949b4a70f3e37ca223aefcf8a" name="a34a4710949b4a70f3e37ca223aefcf8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34a4710949b4a70f3e37ca223aefcf8a">&#9670;&#160;</a></span>initialize_lattice()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#a34a4710949b4a70f3e37ca223aefcf8a">&#9670;&#160;</a></span>initialize_lattice() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -429,7 +418,37 @@ Friends</h2></td></tr>
<p>Initialize the lattice with a random distribution of 1s and -1s. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00044">44</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00049">49</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
</div>
</div>
<a id="acc86effd6889bea199a3d70a9f38dc78" name="acc86effd6889bea199a3d70a9f38dc78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc86effd6889bea199a3d70a9f38dc78">&#9670;&#160;</a></span>initialize_lattice() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void IsingModel::initialize_lattice </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>val</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the lattice with a specific value. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00059">59</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
</div>
</div>
@@ -456,9 +475,9 @@ Friends</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Initialize the magnetization. </p>
<p>Initialize the magnetization of the system. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00074">74</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00088">88</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
</div>
</div>
@@ -487,7 +506,7 @@ Friends</h2></td></tr>
<p>initialize the neighbors matrix. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00056">56</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00070">70</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
</div>
</div>
@@ -508,7 +527,7 @@ Friends</h2></td></tr>
<p>The Metropolis algorithm. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00096">96</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00110">110</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
</div>
</div>
@@ -533,13 +552,15 @@ Friends</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="IsingModel_8hpp_source.html#l00039">39</a> of file <a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a>.</p>
<p>Give access to private members to the test class <a class="el" href="classIsingModelTest.html" title="Test class for the Ising model.">IsingModelTest</a>. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8hpp_source.html#l00040">40</a> of file <a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ae9f872ca2054992161d53306119979dd" name="ae9f872ca2054992161d53306119979dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9f872ca2054992161d53306119979dd">&#9670;&#160;</a></span>E</h2>
<a id="a1c8a2a4331c7e60c3e1350c0cf8300b9" name="a1c8a2a4331c7e60c3e1350c0cf8300b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c8a2a4331c7e60c3e1350c0cf8300b9">&#9670;&#160;</a></span>E</h2>
<div class="memitem">
<div class="memproto">
@@ -548,7 +569,7 @@ Friends</h2></td></tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int IsingModel::E</td>
<td class="memname">int64_t IsingModel::E</td>
</tr>
</table>
</td>
@@ -560,12 +581,12 @@ Friends</h2></td></tr>
<p>The current energy state. unit: \( J \). </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8hpp_source.html#l00068">68</a> of file <a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8hpp_source.html#l00070">70</a> of file <a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a>.</p>
</div>
</div>
<a id="a1a4ceb1bb2593dbd20c51ed04100cbcd" name="a1a4ceb1bb2593dbd20c51ed04100cbcd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1a4ceb1bb2593dbd20c51ed04100cbcd">&#9670;&#160;</a></span>energy_diff</h2>
<a id="a7112dd6433b1bb9512150cbdc1a0b77e" name="a7112dd6433b1bb9512150cbdc1a0b77e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7112dd6433b1bb9512150cbdc1a0b77e">&#9670;&#160;</a></span>energy_diff</h2>
<div class="memitem">
<div class="memproto">
@@ -574,7 +595,7 @@ Friends</h2></td></tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::unordered_map&lt;int, double&gt; IsingModel::energy_diff</td>
<td class="memname">double IsingModel::energy_diff[17]</td>
</tr>
</table>
</td>
@@ -584,9 +605,35 @@ Friends</h2></td></tr>
</table>
</div><div class="memdoc">
<p>A hash map containing all possible energy changes. </p>
<p>An array containing all possible energy differences. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8hpp_source.html#l00056">56</a> of file <a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8hpp_source.html#l00058">58</a> of file <a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a>.</p>
</div>
</div>
<a id="a1bbe0cb10abee98058e7b45b22b9cd0a" name="a1bbe0cb10abee98058e7b45b22b9cd0a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1bbe0cb10abee98058e7b45b22b9cd0a">&#9670;&#160;</a></span>engine</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::mt19937 IsingModel::engine</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The RNG that is used for the Metropolis algorithm. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8hpp_source.html#l00078">78</a> of file <a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a>.</p>
</div>
</div>
@@ -612,7 +659,7 @@ Friends</h2></td></tr>
<p>Size of the lattice. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8hpp_source.html#l00064">64</a> of file <a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8hpp_source.html#l00066">66</a> of file <a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a>.</p>
</div>
</div>
@@ -638,12 +685,12 @@ Friends</h2></td></tr>
<p>\( L \times L \) matrix where element \( x \in {-1, 1}\). </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8hpp_source.html#l00042">42</a> of file <a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8hpp_source.html#l00044">44</a> of file <a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a>.</p>
</div>
</div>
<a id="a0d373a61baca6b0faa607bb12d82cc47" name="a0d373a61baca6b0faa607bb12d82cc47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d373a61baca6b0faa607bb12d82cc47">&#9670;&#160;</a></span>M</h2>
<a id="aef7232b28df08e064ef58eb5ef32f738" name="aef7232b28df08e064ef58eb5ef32f738"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef7232b28df08e064ef58eb5ef32f738">&#9670;&#160;</a></span>M</h2>
<div class="memitem">
<div class="memproto">
@@ -652,7 +699,7 @@ Friends</h2></td></tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int IsingModel::M</td>
<td class="memname">int64_t IsingModel::M</td>
</tr>
</table>
</td>
@@ -664,7 +711,7 @@ Friends</h2></td></tr>
<p>The current magnetic strength. unit: Unitless. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8hpp_source.html#l00072">72</a> of file <a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8hpp_source.html#l00074">74</a> of file <a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a>.</p>
</div>
</div>
@@ -691,7 +738,7 @@ Friends</h2></td></tr>
<p>\( L \times 2 \) matrix with the neighbors of each element \( x_i \). </p>
<p>The reason why it's \( L \times 2 \) instead of \( L \times 2 \), is that we can see that we can use the same column for the left and upper neighbor, and we can use the same column for the right and lower neighbor. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8hpp_source.html#l00052">52</a> of file <a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8hpp_source.html#l00054">54</a> of file <a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a>.</p>
</div>
</div>
@@ -717,7 +764,7 @@ Friends</h2></td></tr>
<p>The temperature of the model. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8hpp_source.html#l00060">60</a> of file <a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8hpp_source.html#l00062">62</a> of file <a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a>.</p>
</div>
</div>