update docs

docs/_m_t_engine_8cpp.html

@@ -110,7 +110,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="_m_t_engine_8cpp.html">MTEngine.cpp</a></li>
-    <li class="footer">Generated on Wed Jun 5 2024 22:12:23 for MTEngine by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0 </li>
+    <li class="footer">Generated on Wed Jun 5 2024 22:46:53 for MTEngine by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0 </li>
   </ul>
 </div>
 </body>

docs/_m_t_engine_8cpp_source.html

@@ -523,7 +523,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="_m_t_engine_8cpp.html">MTEngine.cpp</a></li>
-    <li class="footer">Generated on Wed Jun 5 2024 22:12:23 for MTEngine by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0 </li>
+    <li class="footer">Generated on Wed Jun 5 2024 22:46:53 for MTEngine by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0 </li>
   </ul>
 </div>
 </body>

docs/_m_t_engine_8hpp.html

@@ -129,7 +129,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="_m_t_engine_8hpp.html">MTEngine.hpp</a></li>
-    <li class="footer">Generated on Wed Jun 5 2024 22:12:23 for MTEngine by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0 </li>
+    <li class="footer">Generated on Wed Jun 5 2024 22:46:53 for MTEngine by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0 </li>
   </ul>
 </div>
 </body>

docs/_m_t_engine_8hpp_source.html

@@ -237,7 +237,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="_m_t_engine_8hpp.html">MTEngine.hpp</a></li>
-    <li class="footer">Generated on Wed Jun 5 2024 22:12:23 for MTEngine by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0 </li>
+    <li class="footer">Generated on Wed Jun 5 2024 22:46:53 for MTEngine by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0 </li>
   </ul>
 </div>
 </body>

docs/_r_e_a_d_m_e_8md.html

@@ -101,7 +101,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="_r_e_a_d_m_e_8md.html">README.md</a></li>
-    <li class="footer">Generated on Wed Jun 5 2024 22:12:23 for MTEngine by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0 </li>
+    <li class="footer">Generated on Wed Jun 5 2024 22:46:53 for MTEngine by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0 </li>
   </ul>
 </div>
 </body>

docs/annotated.html

@@ -105,7 +105,7 @@
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
-    <li class="footer">Generated on Wed Jun 5 2024 22:12:23 for MTEngine by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0 </li>
+    <li class="footer">Generated on Wed Jun 5 2024 22:46:53 for MTEngine by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0 </li>
   </ul>
 </div>
 </body>

docs/class_m_t_engine-members.html

@@ -130,7 +130,7 @@
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
-    <li class="footer">Generated on Wed Jun 5 2024 22:12:23 for MTEngine by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0 </li>
+    <li class="footer">Generated on Wed Jun 5 2024 22:46:53 for MTEngine by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0 </li>
   </ul>
 </div>
 </body>

docs/class_m_t_engine.html

@@ -1485,7 +1485,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a0fbc26563096539465ee367c
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="class_m_t_engine.html">MTEngine</a></li>
-    <li class="footer">Generated on Wed Jun 5 2024 22:12:23 for MTEngine by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0 </li>
+    <li class="footer">Generated on Wed Jun 5 2024 22:46:53 for MTEngine by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0 </li>
   </ul>
 </div>
 </body>

docs/classes.html

@@ -106,7 +106,7 @@
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
-    <li class="footer">Generated on Wed Jun 5 2024 22:12:23 for MTEngine by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0 </li>
+    <li class="footer">Generated on Wed Jun 5 2024 22:46:53 for MTEngine by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0 </li>
   </ul>
 </div>
 </body>

docs/example_8cpp.html

@@ -129,17 +129,38 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae66f6b31b5ad750f1fe042a7
         </tr>
       </table>
 </div><div class="memdoc">
+<p>This is the main function where the execution of the program begins. </p>
+<p>An instance of the <a class="el" href="class_m_t_engine.html" title="A class that represents a random number generator engine.">MTEngine</a> class is created. The <a class="el" href="class_m_t_engine.html" title="A class that represents a random number generator engine.">MTEngine</a> class is a pseudorandom number generator, based on the Mersenne Twister algorithm.</p>
+<p>The rand() function of the <a class="el" href="class_m_t_engine.html" title="A class that represents a random number generator engine.">MTEngine</a> class is called to generate a random number. The generated number is then printed to the console.</p>
+<p>The choice() function of the <a class="el" href="class_m_t_engine.html" title="A class that represents a random number generator engine.">MTEngine</a> class is called with three arguments: 1, 2, and 3. This function is assumed to randomly select and return one of the provided arguments. The selected number is then printed to the console.</p>
+<p>A vector of doubles is created with the values 1, 2, 3, 4, and 5.</p>
+<p>The Shuffle() function of the <a class="el" href="class_m_t_engine.html" title="A class that represents a random number generator engine.">MTEngine</a> class is called with the vector as an argument. This function is assumed to randomly rearrange the elements in the provided vector.</p>
+<p>The contents of the vector are printed to the console. Note: This operation requires either a loop to print each element individually or an overloaded operator&lt;&lt; for vectors, neither of which are present in this code.</p>
+<p>The main function returns 0, indicating successful execution of the program.</p>
 
-<p class="definition">Definition at line <a class="el" href="example_8cpp_source.html#l00007">7</a> of file <a class="el" href="example_8cpp_source.html">example.cpp</a>.</p>
-<div class="fragment"><div class="line"><span class="lineno">    7</span>           {</div>
-<div class="line"><span class="lineno">    8</span>    <a class="code hl_class" href="class_m_t_engine.html">MTEngine</a> engine;</div>
-<div class="line"><span class="lineno">    9</span>    std::cout&lt;&lt;engine.<a class="code hl_function" href="class_m_t_engine.html#abf13506763be69dc291d10ac8d0936c5">rand</a>()&lt;&lt;std::endl;</div>
-<div class="line"><span class="lineno">   10</span>    std::cout&lt;&lt;engine.<a class="code hl_function" href="class_m_t_engine.html#a90e46a58f11c4f984fa34b9d972b75d1">choice</a>(1,2,3)&lt;&lt;std::endl;</div>
-<div class="line"><span class="lineno">   11</span>    std::vector&lt;double&gt; v = {1,2,3,4,5};</div>
-<div class="line"><span class="lineno">   12</span>    engine.<a class="code hl_function" href="class_m_t_engine.html#a7e5bc79070625240c2c64bfbe80b0dd9">Shuffle</a>(v);</div>
-<div class="line"><span class="lineno">   13</span>    std::cout&lt;&lt;v&lt;&lt;std::endl;</div>
-<div class="line"><span class="lineno">   14</span>    <span class="keywordflow">return</span> 0;</div>
-<div class="line"><span class="lineno">   15</span>}</div>
+<p class="definition">Definition at line <a class="el" href="example_8cpp_source.html#l00009">9</a> of file <a class="el" href="example_8cpp_source.html">example.cpp</a>.</p>
+<div class="fragment"><div class="line"><span class="lineno">   10</span>{</div>
+<div class="line"><span class="lineno">   15</span> </div>
+<div class="line"><span class="lineno">   16</span>    <a class="code hl_class" href="class_m_t_engine.html">MTEngine</a> engine;</div>
+<div class="line"><span class="lineno">   17</span> </div>
+<div class="line"><span class="lineno">   21</span> </div>
+<div class="line"><span class="lineno">   22</span>    std::cout &lt;&lt; engine.<a class="code hl_function" href="class_m_t_engine.html#abf13506763be69dc291d10ac8d0936c5">rand</a>() &lt;&lt; std::endl;</div>
+<div class="line"><span class="lineno">   23</span> </div>
+<div class="line"><span class="lineno">   28</span> </div>
+<div class="line"><span class="lineno">   29</span>    std::cout &lt;&lt; engine.<a class="code hl_function" href="class_m_t_engine.html#a90e46a58f11c4f984fa34b9d972b75d1">choice</a>(1, 2, 3) &lt;&lt; std::endl;</div>
+<div class="line"><span class="lineno">   30</span> </div>
+<div class="line"><span class="lineno">   33</span> </div>
+<div class="line"><span class="lineno">   34</span>    std::vector&lt;double&gt; v = {1, 2, 3, 4, 5};</div>
+<div class="line"><span class="lineno">   35</span> </div>
+<div class="line"><span class="lineno">   39</span> </div>
+<div class="line"><span class="lineno">   40</span>    engine.<a class="code hl_function" href="class_m_t_engine.html#a7e5bc79070625240c2c64bfbe80b0dd9">Shuffle</a>(v);</div>
+<div class="line"><span class="lineno">   41</span> </div>
+<div class="line"><span class="lineno">   46</span> </div>
+<div class="line"><span class="lineno">   47</span>    std::cout &lt;&lt; v &lt;&lt; std::endl;</div>
+<div class="line"><span class="lineno">   48</span> </div>
+<div class="line"><span class="lineno">   51</span> </div>
+<div class="line"><span class="lineno">   52</span>    <span class="keywordflow">return</span> 0;</div>
+<div class="line"><span class="lineno">   53</span>}</div>
 <div class="ttc" id="aclass_m_t_engine_html"><div class="ttname"><a href="class_m_t_engine.html">MTEngine</a></div><div class="ttdoc">A class that represents a random number generator engine.</div><div class="ttdef"><b>Definition</b> <a href="_m_t_engine_8hpp_source.html#l00021">MTEngine.hpp:22</a></div></div>
 <div class="ttc" id="aclass_m_t_engine_html_a7e5bc79070625240c2c64bfbe80b0dd9"><div class="ttname"><a href="class_m_t_engine.html#a7e5bc79070625240c2c64bfbe80b0dd9">MTEngine::Shuffle</a></div><div class="ttdeci">void Shuffle(std::vector&lt; T &gt; &amp;X)</div><div class="ttdef"><b>Definition</b> <a href="_m_t_engine_8hpp_source.html#l00067">MTEngine.hpp:67</a></div></div>
 <div class="ttc" id="aclass_m_t_engine_html_a90e46a58f11c4f984fa34b9d972b75d1"><div class="ttname"><a href="class_m_t_engine.html#a90e46a58f11c4f984fa34b9d972b75d1">MTEngine::choice</a></div><div class="ttdeci">double choice(double a, double b)</div><div class="ttdef"><b>Definition</b> <a href="_m_t_engine_8cpp_source.html#l00097">MTEngine.cpp:97</a></div></div>
@@ -158,7 +179,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae66f6b31b5ad750f1fe042a7
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="example_8cpp.html">example.cpp</a></li>
-    <li class="footer">Generated on Wed Jun 5 2024 22:12:23 for MTEngine by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0 </li>
+    <li class="footer">Generated on Wed Jun 5 2024 22:46:53 for MTEngine by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0 </li>
   </ul>
 </div>
 </body>