Update docs
This commit is contained in:
@@ -109,23 +109,30 @@ $(document).ready(function(){initNavTree('main_8cpp.html',''); initResizable();
|
||||
<div class="textblock"><code>#include "<a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>"</code><br />
|
||||
<code>#include "<a class="el" href="monte__carlo_8hpp_source.html">monte_carlo.hpp</a>"</code><br />
|
||||
<code>#include "<a class="el" href="utils_8hpp_source.html">utils.hpp</a>"</code><br />
|
||||
<code>#include <csignal></code><br />
|
||||
<code>#include <cstdlib></code><br />
|
||||
<code>#include <iostream></code><br />
|
||||
<code>#include <omp.h></code><br />
|
||||
<code>#include <getopt.h></code><br />
|
||||
</div>
|
||||
<p><a href="main_8cpp_source.html">Go to the source code of this file.</a></p>
|
||||
<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:a68406fc2dd8de5849c3984658c171f32"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="main_8cpp.html#a68406fc2dd8de5849c3984658c171f32">create_burn_in_time_data</a> ()</td></tr>
|
||||
<tr class="memdesc:a68406fc2dd8de5849c3984658c171f32"><td class="mdescLeft"> </td><td class="mdescRight">Create the data for the burn-in time for temperatures 1.0 and 2.4 for both unordered and ordered initial states. <br /></td></tr>
|
||||
<tr class="separator:a68406fc2dd8de5849c3984658c171f32"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a4f8ea24364d72024915d3753a572cc5b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="main_8cpp.html#a4f8ea24364d72024915d3753a572cc5b">create_pd_estimate_data</a> ()</td></tr>
|
||||
<tr class="memdesc:a4f8ea24364d72024915d3753a572cc5b"><td class="mdescLeft"> </td><td class="mdescRight">Create the data used to estimate the probability distribution for tempratures 1.0 anbd 2.4. <br /></td></tr>
|
||||
<tr class="separator:a4f8ea24364d72024915d3753a572cc5b"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a746d8dc451b2b2536abbb1ff1acaf861"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="main_8cpp.html#a746d8dc451b2b2536abbb1ff1acaf861">test_burn_in_time</a> ()</td></tr>
|
||||
<tr class="memdesc:a746d8dc451b2b2536abbb1ff1acaf861"><td class="mdescLeft"> </td><td class="mdescRight">Create data using the same parameters except one uses burn-in time, while the other doesn't. <br /></td></tr>
|
||||
<tr class="separator:a746d8dc451b2b2536abbb1ff1acaf861"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a0dfa85080578dffff23b68e372cece95"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="main_8cpp.html#a0dfa85080578dffff23b68e372cece95">test_parallel_speedup</a> ()</td></tr>
|
||||
<tr class="memdesc:a0dfa85080578dffff23b68e372cece95"><td class="mdescLeft"> </td><td class="mdescRight">Test how much Openmp speeds up. <br /></td></tr>
|
||||
<tr class="separator:a0dfa85080578dffff23b68e372cece95"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a9d62cf1399596f4c5a39abdd3196d76d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="main_8cpp.html#a9d62cf1399596f4c5a39abdd3196d76d">create_phase_transition_data</a> ()</td></tr>
|
||||
<tr class="memdesc:a9d62cf1399596f4c5a39abdd3196d76d"><td class="mdescLeft"> </td><td class="mdescRight">Create data for studying phase transition. <br /></td></tr>
|
||||
<tr class="separator:a9d62cf1399596f4c5a39abdd3196d76d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ac907e18135856c90366aaa599a9e10b1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="main_8cpp.html#ac907e18135856c90366aaa599a9e10b1">usage</a> (std::string filename)</td></tr>
|
||||
<tr class="memdesc:ac907e18135856c90366aaa599a9e10b1"><td class="mdescLeft"> </td><td class="mdescRight">A function that displays how to use the program and quits. <br /></td></tr>
|
||||
<tr class="separator:ac907e18135856c90366aaa599a9e10b1"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a3c04138a5bfe5d72780bb7e82a18e627"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="main_8cpp.html#a3c04138a5bfe5d72780bb7e82a18e627">main</a> (int argc, char **argv)</td></tr>
|
||||
<tr class="memdesc:a3c04138a5bfe5d72780bb7e82a18e627"><td class="mdescLeft"> </td><td class="mdescRight">The main function. <br /></td></tr>
|
||||
<tr class="separator:a3c04138a5bfe5d72780bb7e82a18e627"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
@@ -136,7 +143,7 @@ Functions</h2></td></tr>
|
||||
<dd>
|
||||
Janita Ovidie Sandtrøen Willumsen (janitaws)</dd></dl>
|
||||
<dl class="section version"><dt>Version</dt><dd>0.1</dd></dl>
|
||||
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000010">Bug:</a></b></dt><dd>No known bugs </dd></dl>
|
||||
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000005">Bug:</a></b></dt><dd>No known bugs </dd></dl>
|
||||
|
||||
<p class="definition">Definition in file <a class="el" href="main_8cpp_source.html">main.cpp</a>.</p>
|
||||
</div><h2 class="groupheader">Function Documentation</h2>
|
||||
@@ -155,6 +162,8 @@ Janita Ovidie Sandtrøen Willumsen (janitaws)</dd></dl>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Create the data for the burn-in time for temperatures 1.0 and 2.4 for both unordered and ordered initial states. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="main_8cpp_source.html#l00021">21</a> of file <a class="el" href="main_8cpp_source.html">main.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
@@ -174,7 +183,9 @@ Janita Ovidie Sandtrøen Willumsen (janitaws)</dd></dl>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="main_8cpp_source.html#l00034">34</a> of file <a class="el" href="main_8cpp_source.html">main.cpp</a>.</p>
|
||||
<p>Create the data used to estimate the probability distribution for tempratures 1.0 anbd 2.4. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="main_8cpp_source.html#l00037">37</a> of file <a class="el" href="main_8cpp_source.html">main.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -193,7 +204,9 @@ Janita Ovidie Sandtrøen Willumsen (janitaws)</dd></dl>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="main_8cpp_source.html#l00062">62</a> of file <a class="el" href="main_8cpp_source.html">main.cpp</a>.</p>
|
||||
<p>Create data for studying phase transition. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="main_8cpp_source.html#l00083">83</a> of file <a class="el" href="main_8cpp_source.html">main.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -225,7 +238,28 @@ Janita Ovidie Sandtrøen Willumsen (janitaws)</dd></dl>
|
||||
|
||||
<p>The main function. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="main_8cpp_source.html#l00084">84</a> of file <a class="el" href="main_8cpp_source.html">main.cpp</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="main_8cpp_source.html#l00125">125</a> of file <a class="el" href="main_8cpp_source.html">main.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a746d8dc451b2b2536abbb1ff1acaf861" name="a746d8dc451b2b2536abbb1ff1acaf861"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a746d8dc451b2b2536abbb1ff1acaf861">◆ </a></span>test_burn_in_time()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void test_burn_in_time </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Create data using the same parameters except one uses burn-in time, while the other doesn't. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="main_8cpp_source.html#l00049">49</a> of file <a class="el" href="main_8cpp_source.html">main.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -244,7 +278,31 @@ Janita Ovidie Sandtrøen Willumsen (janitaws)</dd></dl>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="main_8cpp_source.html#l00041">41</a> of file <a class="el" href="main_8cpp_source.html">main.cpp</a>.</p>
|
||||
<p>Test how much Openmp speeds up. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="main_8cpp_source.html#l00060">60</a> of file <a class="el" href="main_8cpp_source.html">main.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ac907e18135856c90366aaa599a9e10b1" name="ac907e18135856c90366aaa599a9e10b1"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ac907e18135856c90366aaa599a9e10b1">◆ </a></span>usage()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void usage </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">std::string </td>
|
||||
<td class="paramname"><em>filename</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>A function that displays how to use the program and quits. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="main_8cpp_source.html#l00110">110</a> of file <a class="el" href="main_8cpp_source.html">main.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user