Update docs
This commit is contained in:
@@ -102,28 +102,26 @@ $(document).ready(function(){initNavTree('files.html',''); initResizable(); });
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<div class="textblock">Here is a list of all documented files with brief descriptions:</div><div class="directory">
|
||||
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span>]</div><table class="directory">
|
||||
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span>]</div><table class="directory">
|
||||
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">▼</span><span id="img_0_" class="iconfopen" onclick="toggleFolder('0_')"> </span><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html" target="_self">include</a></td><td class="desc"></td></tr>
|
||||
<tr id="row_0_0_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="constants_8hpp_source.html"><span class="icondoc"></span></a><a class="el" href="constants_8hpp.html" target="_self">constants.hpp</a></td><td class="desc">Library of constants </td></tr>
|
||||
<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="data__type_8hpp_source.html"><span class="icondoc"></span></a><a class="el" href="data__type_8hpp.html" target="_self">data_type.hpp</a></td><td class="desc">Header for the <a class="el" href="classdata__t.html">data_t</a> type </td></tr>
|
||||
<tr id="row_0_2_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="IsingModel_8hpp_source.html"><span class="icondoc"></span></a><a class="el" href="IsingModel_8hpp.html" target="_self">IsingModel.hpp</a></td><td class="desc">The definition of the Ising model </td></tr>
|
||||
<tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="monte__carlo_8hpp_source.html"><span class="icondoc"></span></a><a class="el" href="monte__carlo_8hpp.html" target="_self">monte_carlo.hpp</a></td><td class="desc">Functions for monte carlo simulations </td></tr>
|
||||
<tr id="row_0_4_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="testlib_8hpp_source.html"><span class="icondoc"></span></a><a class="el" href="testlib_8hpp.html" target="_self">testlib.hpp</a></td><td class="desc">A small test library </td></tr>
|
||||
<tr id="row_0_5_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="typedefs_8hpp_source.html"><span class="icondoc"></span></a><a class="el" href="typedefs_8hpp.html" target="_self">typedefs.hpp</a></td><td class="desc">Useful typedefs for cleaner code </td></tr>
|
||||
<tr id="row_0_6_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="utils_8hpp_source.html"><span class="icondoc"></span></a><a class="el" href="utils_8hpp.html" target="_self">utils.hpp</a></td><td class="desc">Function prototypes and macros that are useful </td></tr>
|
||||
<tr id="row_0_0_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="data__type_8hpp_source.html"><span class="icondoc"></span></a><a class="el" href="data__type_8hpp.html" target="_self">data_type.hpp</a></td><td class="desc">Header for the <a class="el" href="classdata__t.html" title="Type to use with the IsingModel class and montecarlo module.">data_t</a> type </td></tr>
|
||||
<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="IsingModel_8hpp_source.html"><span class="icondoc"></span></a><a class="el" href="IsingModel_8hpp.html" target="_self">IsingModel.hpp</a></td><td class="desc">The definition of the Ising model </td></tr>
|
||||
<tr id="row_0_2_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="monte__carlo_8hpp_source.html"><span class="icondoc"></span></a><a class="el" href="monte__carlo_8hpp.html" target="_self">monte_carlo.hpp</a></td><td class="desc">Functions for Monte Carlo simulations </td></tr>
|
||||
<tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="testlib_8hpp_source.html"><span class="icondoc"></span></a><a class="el" href="testlib_8hpp.html" target="_self">testlib.hpp</a></td><td class="desc">A small test library </td></tr>
|
||||
<tr id="row_0_4_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="utils_8hpp_source.html"><span class="icondoc"></span></a><a class="el" href="utils_8hpp.html" target="_self">utils.hpp</a></td><td class="desc">Function prototypes and macros that are useful </td></tr>
|
||||
<tr id="row_1_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_1_" class="arrow" onclick="toggleFolder('1_')">▼</span><span id="img_1_" class="iconfopen" onclick="toggleFolder('1_')"> </span><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html" target="_self">src</a></td><td class="desc"></td></tr>
|
||||
<tr id="row_1_0_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span id="arr_1_0_" class="arrow" onclick="toggleFolder('1_0_')">▼</span><span id="img_1_0_" class="iconfopen" onclick="toggleFolder('1_0_')"> </span><a class="el" href="dir_634e799a3947388232110823971192a8.html" target="_self">scripts</a></td><td class="desc"></td></tr>
|
||||
<tr id="row_1_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </span><a href="burn__in__time_8py_source.html"><span class="icondoc"></span></a><b>burn_in_time.py</b></td><td class="desc"></td></tr>
|
||||
<tr id="row_1_0_1_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;"> </span><a href="pd__estimate_8py_source.html"><span class="icondoc"></span></a><b>pd_estimate.py</b></td><td class="desc"></td></tr>
|
||||
<tr id="row_1_0_2_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </span><a href="phase__transition_8py_source.html"><span class="icondoc"></span></a><b>phase_transition.py</b></td><td class="desc"></td></tr>
|
||||
<tr id="row_1_1_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="data__type_8cpp_source.html"><span class="icondoc"></span></a><a class="el" href="data__type_8cpp.html" target="_self">data_type.cpp</a></td><td class="desc">Implementation for the <a class="el" href="classdata__t.html">data_t</a> type </td></tr>
|
||||
<tr id="row_1_2_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="IsingModel_8cpp_source.html"><span class="icondoc"></span></a><a class="el" href="IsingModel_8cpp.html" target="_self">IsingModel.cpp</a></td><td class="desc">The implementation of the Ising model </td></tr>
|
||||
<tr id="row_1_3_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="main_8cpp_source.html"><span class="icondoc"></span></a><a class="el" href="main_8cpp.html" target="_self">main.cpp</a></td><td class="desc">The main program </td></tr>
|
||||
<tr id="row_1_4_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="monte__carlo_8cpp_source.html"><span class="icondoc"></span></a><a class="el" href="monte__carlo_8cpp.html" target="_self">monte_carlo.cpp</a></td><td class="desc">Implementation of the monte carlo functions </td></tr>
|
||||
<tr id="row_1_5_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="phase__transition__mpi_8cpp_source.html"><span class="icondoc"></span></a><a class="el" href="phase__transition__mpi_8cpp.html" target="_self">phase_transition_mpi.cpp</a></td><td class="desc">Sweep over different temperatures and generate data </td></tr>
|
||||
<tr id="row_1_6_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="test__suite_8cpp_source.html"><span class="icondoc"></span></a><a class="el" href="test__suite_8cpp.html" target="_self">test_suite.cpp</a></td><td class="desc">Sweep over different temperatures and generate data </td></tr>
|
||||
<tr id="row_1_7_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="testlib_8cpp_source.html"><span class="icondoc"></span></a><a class="el" href="testlib_8cpp.html" target="_self">testlib.cpp</a></td><td class="desc">Implementation of the testing library </td></tr>
|
||||
<tr id="row_1_8_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="utils_8cpp_source.html"><span class="icondoc"></span></a><a class="el" href="utils_8cpp.html" target="_self">utils.cpp</a></td><td class="desc">Implementation of the utils </td></tr>
|
||||
<tr id="row_1_0_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="data__type_8cpp_source.html"><span class="icondoc"></span></a><a class="el" href="data__type_8cpp.html" target="_self">data_type.cpp</a></td><td class="desc">Implementation for the <a class="el" href="classdata__t.html" title="Type to use with the IsingModel class and montecarlo module.">data_t</a> type </td></tr>
|
||||
<tr id="row_1_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="IsingModel_8cpp_source.html"><span class="icondoc"></span></a><a class="el" href="IsingModel_8cpp.html" target="_self">IsingModel.cpp</a></td><td class="desc">The implementation of the Ising model </td></tr>
|
||||
<tr id="row_1_2_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="main_8cpp_source.html"><span class="icondoc"></span></a><a class="el" href="main_8cpp.html" target="_self">main.cpp</a></td><td class="desc">The main program </td></tr>
|
||||
<tr id="row_1_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="mcmc__progression_8cpp_source.html"><span class="icondoc"></span></a><a class="el" href="mcmc__progression_8cpp.html" target="_self">mcmc_progression.cpp</a></td><td class="desc">Execute the mcmc algorithm and write data to file after each Monte Carlo cycle </td></tr>
|
||||
<tr id="row_1_4_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="monte__carlo_8cpp_source.html"><span class="icondoc"></span></a><a class="el" href="monte__carlo_8cpp.html" target="_self">monte_carlo.cpp</a></td><td class="desc">Implementation of the monte carlo functions </td></tr>
|
||||
<tr id="row_1_5_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="pd__estimate_8cpp_source.html"><span class="icondoc"></span></a><a class="el" href="pd__estimate_8cpp.html" target="_self">pd_estimate.cpp</a></td><td class="desc">Execute the mcmc algorithm and write data to file after each Monte Carlo cycles </td></tr>
|
||||
<tr id="row_1_6_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="phase__transition_8cpp_source.html"><span class="icondoc"></span></a><a class="el" href="phase__transition_8cpp.html" target="_self">phase_transition.cpp</a></td><td class="desc">Sweep over different temperatures and generate data </td></tr>
|
||||
<tr id="row_1_7_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="phase__transition__mpi_8cpp_source.html"><span class="icondoc"></span></a><a class="el" href="phase__transition__mpi_8cpp.html" target="_self">phase_transition_mpi.cpp</a></td><td class="desc">Sweep over different temperatures and generate data </td></tr>
|
||||
<tr id="row_1_8_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="test__suite_8cpp_source.html"><span class="icondoc"></span></a><a class="el" href="test__suite_8cpp.html" target="_self">test_suite.cpp</a></td><td class="desc">Sweep over different temperatures and generate data </td></tr>
|
||||
<tr id="row_1_9_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="testlib_8cpp_source.html"><span class="icondoc"></span></a><a class="el" href="testlib_8cpp.html" target="_self">testlib.cpp</a></td><td class="desc">Implementation of the testing library </td></tr>
|
||||
<tr id="row_1_10_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="time_8cpp_source.html"><span class="icondoc"></span></a><a class="el" href="time_8cpp.html" target="_self">time.cpp</a></td><td class="desc">Timing various things </td></tr>
|
||||
<tr id="row_1_11_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a href="utils_8cpp_source.html"><span class="icondoc"></span></a><a class="el" href="utils_8cpp.html" target="_self">utils.cpp</a></td><td class="desc">Implementation of the utils </td></tr>
|
||||
</table>
|
||||
</div><!-- directory -->
|
||||
</div><!-- contents -->
|
||||
|
||||
Reference in New Issue
Block a user