Documentation for 05bb23ca27

This commit is contained in:
github-actions
2020-07-10 16:50:36 +00:00
parent 2936d28962
commit fc46f441ae
172 changed files with 6067 additions and 3376 deletions

View File

@@ -443,9 +443,11 @@ $(document).ready(function(){initNavTree('d4/d86/large__number_8h_source.html','
<div class="ttc" id="akohonen__som__topology_8cpp_html_a3c04138a5bfe5d72780bb7e82a18e627"><div class="ttname"><a href="../../d4/def/kohonen__som__topology_8cpp.html#a3c04138a5bfe5d72780bb7e82a18e627">main</a></div><div class="ttdeci">int main(int argc, char **argv)</div><div class="ttdef"><b>Definition:</b> kohonen_som_topology.cpp:566</div></div>
<div class="ttc" id="aclass_trie_html_a6d10eb1669453395d1900ebd401954fb"><div class="ttname"><a href="../../dd/d2f/class_trie.html#a6d10eb1669453395d1900ebd401954fb">Trie::hasChildren</a></div><div class="ttdeci">static bool hasChildren(std::shared_ptr&lt; TrieNode &gt; node)</div><div class="ttdef"><b>Definition:</b> trie_modern.cpp:41</div></div>
<div class="ttc" id="aclass_complex_html_a36739619a07b5478bcd8a28ad2f8b7da"><div class="ttname"><a href="../../da/d5a/class_complex.html#a36739619a07b5478bcd8a28ad2f8b7da">Complex::operator-</a></div><div class="ttdeci">Complex operator-(const Complex &amp;other)</div><div class="ttdoc">Operator overload of '-' on Complex class. Operator overload to be able to subtract two complex numbe...</div><div class="ttdef"><b>Definition:</b> complex_numbers.cpp:106</div></div>
<div class="ttc" id="aspirograph_8cpp_html_a3c04138a5bfe5d72780bb7e82a18e627"><div class="ttname"><a href="../../da/d77/spirograph_8cpp.html#a3c04138a5bfe5d72780bb7e82a18e627">main</a></div><div class="ttdeci">int main(int argc, char **argv)</div><div class="ttdef"><b>Definition:</b> spirograph.cpp:268</div></div>
<div class="ttc" id="aclass_complex_html_a466cd7b664cc6a864937ceb3dead1323"><div class="ttname"><a href="../../da/d5a/class_complex.html#a466cd7b664cc6a864937ceb3dead1323">Complex::Complex</a></div><div class="ttdeci">Complex(const Complex &amp;other)</div><div class="ttdoc">Copy Constructor.</div><div class="ttdef"><b>Definition:</b> complex_numbers.cpp:58</div></div>
<div class="ttc" id="aemplace_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/queue/emplace.html">std::queue::emplace</a></div><div class="ttdeci">T emplace(T... args)</div></div>
<div class="ttc" id="aclass_complex_html_a3cfc522c782726f49ee20af17b77f867"><div class="ttname"><a href="../../da/d5a/class_complex.html#a3cfc522c782726f49ee20af17b77f867">Complex::Complex</a></div><div class="ttdeci">Complex(double x=0.f, double y=0.f, bool is_polar=false)</div><div class="ttdoc">Complex Constructor which initialises our complex number.</div><div class="ttdef"><b>Definition:</b> complex_numbers.cpp:43</div></div>
<div class="ttc" id="abasic_stringstream_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/basic_stringstream.html">std::stringstream</a></div><div class="ttdoc">STL class.</div></div>
<div class="ttc" id="aclass_complex_html_ae5b51b749ea4964104b9527af9d8f556"><div class="ttname"><a href="../../da/d5a/class_complex.html#ae5b51b749ea4964104b9527af9d8f556">Complex::abs</a></div><div class="ttdeci">double abs() const</div><div class="ttdoc">Member function to give the modulus of our complex number. Member function to which gives the absolut...</div><div class="ttdef"><b>Definition:</b> complex_numbers.cpp:79</div></div>
<div class="ttc" id="alarge__factorial_8cpp_html_a0ddf1224851353fc92bfbff6f499fa97"><div class="ttname"><a href="../../d6/d9d/large__factorial_8cpp.html#a0ddf1224851353fc92bfbff6f499fa97">main</a></div><div class="ttdeci">int main(int argc, char *argv[])</div><div class="ttdef"><b>Definition:</b> large_factorial.cpp:89</div></div>
<div class="ttc" id="akohonen__som__trace_8cpp_html_a9ab8c79ffb674a63f151f282faeb723b"><div class="ttname"><a href="../../d9/d49/kohonen__som__trace_8cpp.html#a9ab8c79ffb674a63f151f282faeb723b">test_3d_classes</a></div><div class="ttdeci">void test_3d_classes(std::vector&lt; std::valarray&lt; double &gt;&gt; *data)</div><div class="ttdef"><b>Definition:</b> kohonen_som_trace.cpp:347</div></div>
@@ -462,6 +464,7 @@ $(document).ready(function(){initNavTree('d4/d86/large__number_8h_source.html','
<div class="ttc" id="ahash__search_8cpp_html_a8ca8dcb494104d273679e219e53d0555"><div class="ttname"><a href="../../d1/df3/hash__search_8cpp.html#a8ca8dcb494104d273679e219e53d0555">node</a></div><div class="ttdeci">struct list node</div></div>
<div class="ttc" id="afscanf_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/c/fscanf.html">std::scanf</a></div><div class="ttdeci">T scanf(T... args)</div></div>
<div class="ttc" id="akohonen__som__trace_8cpp_html_a2256c10b16edba377b64a44b6c656908"><div class="ttname"><a href="../../d9/d49/kohonen__som__trace_8cpp.html#a2256c10b16edba377b64a44b6c656908">get_clock_diff</a></div><div class="ttdeci">double get_clock_diff(clock_t start_t, clock_t end_t)</div><div class="ttdef"><b>Definition:</b> kohonen_som_trace.cpp:438</div></div>
<div class="ttc" id="ahill__cipher_8cpp_html_a04391124480d2a49f2dec900237b0712"><div class="ttname"><a href="../../d7/db9/hill__cipher_8cpp.html#a04391124480d2a49f2dec900237b0712">test2</a></div><div class="ttdeci">void test2(const std::string &amp;text)</div><div class="ttdoc">Self test 2 - using 8x8 randomly generated key.</div><div class="ttdef"><b>Definition:</b> hill_cipher.cpp:505</div></div>
<div class="ttc" id="asetfill_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/manip/setfill.html">std::setfill</a></div><div class="ttdeci">T setfill(T... args)</div></div>
<div class="ttc" id="areverse_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/algorithm/reverse.html">std::reverse</a></div><div class="ttdeci">T reverse(T... args)</div></div>
<div class="ttc" id="aclass_graph_html_aa99d44d3179d5bbbfa84a5031cf80cb1"><div class="ttname"><a href="../../da/d9a/class_graph.html#aa99d44d3179d5bbbfa84a5031cf80cb1">Graph::Graph</a></div><div class="ttdeci">Graph(unsigned int vertices, std::vector&lt; Edge &gt; const &amp;edges)</div><div class="ttdef"><b>Definition:</b> cycle_check_directed_graph.cpp:90</div></div>
@@ -485,9 +488,11 @@ $(document).ready(function(){initNavTree('d4/d86/large__number_8h_source.html','
<div class="ttc" id="aparanthesis__matching_8cpp_html_af4c937d823c412d99fbe60c99dbf0a4f"><div class="ttname"><a href="../../dc/dc5/paranthesis__matching_8cpp.html#af4c937d823c412d99fbe60c99dbf0a4f">stack_idx</a></div><div class="ttdeci">int stack_idx</div><div class="ttdoc">pointer to track stack index</div><div class="ttdef"><b>Definition:</b> paranthesis_matching.cpp:23</div></div>
<div class="ttc" id="astruct_entry_html"><div class="ttname"><a href="../../dd/d3b/struct_entry.html">Entry</a></div><div class="ttdef"><b>Definition:</b> double_hash_hash_table.cpp:28</div></div>
<div class="ttc" id="akohonen__som__trace_8cpp_html_a1440a7779ac56f47a3f355ce4a8c7da0"><div class="ttname"><a href="../../d9/d49/kohonen__som__trace_8cpp.html#a1440a7779ac56f47a3f355ce4a8c7da0">test1</a></div><div class="ttdeci">void test1()</div><div class="ttdef"><b>Definition:</b> kohonen_som_trace.cpp:225</div></div>
<div class="ttc" id="aclear_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/basic_ios/clear.html">std::stringstream::clear</a></div><div class="ttdeci">T clear(T... args)</div></div>
<div class="ttc" id="aclasslarge__number_html_ac27b399ed872731758ec33ebb102730e"><div class="ttname"><a href="../../db/d82/classlarge__number.html#ac27b399ed872731758ec33ebb102730e">large_number::operator+=</a></div><div class="ttdeci">large_number &amp; operator+=(large_number n)</div><div class="ttdef"><b>Definition:</b> large_number.h:192</div></div>
<div class="ttc" id="astructquery_html"><div class="ttname"><a href="../../dd/d1b/structquery.html">query</a></div><div class="ttdef"><b>Definition:</b> mo.cpp:6</div></div>
<div class="ttc" id="aordinary__least__squares__regressor_8cpp_html_ab6171f4db68a5e50ae0f3500a63acd26"><div class="ttname"><a href="../../dc/d38/ordinary__least__squares__regressor_8cpp.html#ab6171f4db68a5e50ae0f3500a63acd26">operator*</a></div><div class="ttdeci">std::vector&lt; std::vector&lt; T &gt; &gt; operator*(std::vector&lt; std::vector&lt; T &gt;&gt; const &amp;A, std::vector&lt; std::vector&lt; T &gt;&gt; const &amp;B)</div><div class="ttdef"><b>Definition:</b> ordinary_least_squares_regressor.cpp:74</div></div>
<div class="ttc" id="anamespacespirograph_html"><div class="ttname"><a href="../../da/dd3/namespacespirograph.html">spirograph</a></div></div>
<div class="ttc" id="acheck__prime_8cpp_html_aa18b3517017d99bb4024853bddba5532"><div class="ttname"><a href="../../db/d93/check__prime_8cpp.html#aa18b3517017d99bb4024853bddba5532">is_prime</a></div><div class="ttdeci">bool is_prime(T num)</div><div class="ttdef"><b>Definition:</b> check_prime.cpp:22</div></div>
<div class="ttc" id="afast__power_8cpp_html_a8399b847626e5bba983cab7c7918b445"><div class="ttname"><a href="../../d2/d0b/fast__power_8cpp.html#a8399b847626e5bba983cab7c7918b445">fast_power_recursive</a></div><div class="ttdeci">double fast_power_recursive(T a, T b)</div><div class="ttdef"><b>Definition:</b> fast_power.cpp:26</div></div>
<div class="ttc" id="atie_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/tuple/tie.html">std::tie</a></div><div class="ttdeci">T tie(T... args)</div></div>
@@ -536,6 +541,7 @@ $(document).ready(function(){initNavTree('d4/d86/large__number_8h_source.html','
<div class="ttc" id="aclass_edge_html_a415a5d002fe11c58711e48aabe975980"><div class="ttname"><a href="../../d7/d77/class_edge.html#a415a5d002fe11c58711e48aabe975980">Edge::Edge</a></div><div class="ttdeci">Edge(unsigned int source, unsigned int destination)</div><div class="ttdef"><b>Definition:</b> cycle_check_directed_graph.cpp:42</div></div>
<div class="ttc" id="aclass_trie_html_a6af57e9f25d0d0a2d59eea5a4a802908"><div class="ttname"><a href="../../dd/d2f/class_trie.html#a6af57e9f25d0d0a2d59eea5a4a802908">Trie::Trie</a></div><div class="ttdeci">Trie()</div><div class="ttdoc">constructor to initialise the root of the trie.</div><div class="ttdef"><b>Definition:</b> trie_modern.cpp:103</div></div>
<div class="ttc" id="astructmst_html"><div class="ttname"><a href="../../d1/d77/structmst.html">mst</a></div><div class="ttdef"><b>Definition:</b> prims_minimum_spanning_tree.cpp:9</div></div>
<div class="ttc" id="aarray_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/array.html">std::array</a></div><div class="ttdoc">STL class.</div></div>
<div class="ttc" id="aclass_graph_html_ac85c63bcca4764a621f9f8609a8e5910"><div class="ttname"><a href="../../da/d9a/class_graph.html#ac85c63bcca4764a621f9f8609a8e5910">Graph::addEdge</a></div><div class="ttdeci">void addEdge(unsigned int source, unsigned int destination)</div><div class="ttdef"><b>Definition:</b> cycle_check_directed_graph.cpp:140</div></div>
<div class="ttc" id="amath_2armstrong__number_8cpp_html_ae1a3968e7947464bee7714f6d43b7002"><div class="ttname"><a href="../../d4/d5d/math_2armstrong__number_8cpp.html#ae1a3968e7947464bee7714f6d43b7002">test</a></div><div class="ttdeci">void test()</div><div class="ttdef"><b>Definition:</b> armstrong_number.cpp:59</div></div>
<div class="ttc" id="aclose_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/basic_ofstream/close.html">std::ofstream::close</a></div><div class="ttdeci">T close(T... args)</div></div>
@@ -586,6 +592,7 @@ $(document).ready(function(){initNavTree('d4/d86/large__number_8h_source.html','
<div class="ttc" id="ahash__search_8cpp_html_a6e1a77282bc65ad359d753d25df23243"><div class="ttname"><a href="../../d1/df3/hash__search_8cpp.html#a6e1a77282bc65ad359d753d25df23243">data</a></div><div class="ttdeci">int data[MAX]</div><div class="ttdoc">test data</div><div class="ttdef"><b>Definition:</b> hash_search.cpp:24</div></div>
<div class="ttc" id="aclass_complex_html_af8aacf982e2e6c142921bc850f6dc974"><div class="ttname"><a href="../../da/d5a/class_complex.html#af8aacf982e2e6c142921bc850f6dc974">Complex::imag</a></div><div class="ttdeci">double imag() const</div><div class="ttdoc">Member function to get imaginary value of our complex number. Member function (getter) to access the ...</div><div class="ttdef"><b>Definition:</b> complex_numbers.cpp:70</div></div>
<div class="ttc" id="around_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/numeric/math/round.html">std::round</a></div><div class="ttdeci">T round(T... args)</div></div>
<div class="ttc" id="anamespacespirograph_html_a8e83a64e8443fff1e5ffdc1c299c1e99"><div class="ttname"><a href="../../da/dd3/namespacespirograph.html#a8e83a64e8443fff1e5ffdc1c299c1e99">spirograph::test</a></div><div class="ttdeci">void test()</div><div class="ttdoc">Test function to save resulting points to a CSV file.</div><div class="ttdef"><b>Definition:</b> spirograph.cpp:93</div></div>
<div class="ttc" id="aclassqueue_html"><div class="ttname"><a href="../../db/da9/classqueue.html">queue</a></div><div class="ttdef"><b>Definition:</b> queue.h:17</div></div>
<div class="ttc" id="aclasslarge__number_html_a959c5c1a982949bbf98e1ea0f9afe6a9"><div class="ttname"><a href="../../db/d82/classlarge__number.html#a959c5c1a982949bbf98e1ea0f9afe6a9">large_number::test</a></div><div class="ttdeci">static bool test()</div><div class="ttdef"><b>Definition:</b> large_number.h:65</div></div>
<div class="ttc" id="aordinary__least__squares__regressor_8cpp_html_a38ff1d954e9b7de93eb20e2dd101a045"><div class="ttname"><a href="../../dc/d38/ordinary__least__squares__regressor_8cpp.html#a38ff1d954e9b7de93eb20e2dd101a045">fit_OLS_regressor</a></div><div class="ttdeci">std::vector&lt; float &gt; fit_OLS_regressor(std::vector&lt; std::vector&lt; T &gt;&gt; const &amp;X, std::vector&lt; T &gt; const &amp;Y)</div><div class="ttdef"><b>Definition:</b> ordinary_least_squares_regressor.cpp:312</div></div>
@@ -632,6 +639,7 @@ $(document).ready(function(){initNavTree('d4/d86/large__number_8h_source.html','
<div class="ttc" id="aclassstack_html_a066e4505155b009913c47b2648b1067a"><div class="ttname"><a href="../../d1/dc2/classstack.html#a066e4505155b009913c47b2648b1067a">stack::isEmptyStack</a></div><div class="ttdeci">bool isEmptyStack()</div><div class="ttdef"><b>Definition:</b> stack.h:80</div></div>
<div class="ttc" id="aclass_graph_html_a8aa88a88269773cc4dba255dec035898"><div class="ttname"><a href="../../da/d9a/class_graph.html#a8aa88a88269773cc4dba255dec035898">Graph::getVertices</a></div><div class="ttdeci">std::remove_reference_t&lt; unsigned int &gt; const &amp; getVertices() const</div><div class="ttdef"><b>Definition:</b> cycle_check_directed_graph.cpp:112</div></div>
<div class="ttc" id="acomplex_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/numeric/complex.html">std::complex</a></div><div class="ttdoc">STL class.</div></div>
<div class="ttc" id="astr_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/basic_stringstream/str.html">std::stringstream::str</a></div><div class="ttdeci">T str(T... args)</div></div>
<div class="ttc" id="aimag_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/numeric/complex/imag.html">std::complex::imag</a></div><div class="ttdeci">T imag(T... args)</div></div>
<div class="ttc" id="astructlca_html"><div class="ttname"><a href="../../dd/df4/structlca.html">lca</a></div><div class="ttdef"><b>Definition:</b> lca.cpp:10</div></div>
<div class="ttc" id="astring__fibonacci_8cpp_html_a28052eee05d43c2ebc5147c52bd50c35"><div class="ttname"><a href="../../de/d47/string__fibonacci_8cpp.html#a28052eee05d43c2ebc5147c52bd50c35">add</a></div><div class="ttdeci">std::string add(std::string a, std::string b)</div><div class="ttdef"><b>Definition:</b> string_fibonacci.cpp:24</div></div>
@@ -660,6 +668,7 @@ $(document).ready(function(){initNavTree('d4/d86/large__number_8h_source.html','
<div class="ttc" id="agroup__machine__learning_html_gaf5ce14f026d6d231bef29161bac2b485"><div class="ttname"><a href="../../d9/d66/group__machine__learning.html#gaf5ce14f026d6d231bef29161bac2b485">_random</a></div><div class="ttdeci">double _random(double a, double b)</div><div class="ttdef"><b>Definition:</b> kohonen_som_topology.cpp:50</div></div>
<div class="ttc" id="aclass_graph_html_af765dda8f21280e1cecea19e129f1bc5"><div class="ttname"><a href="../../da/d9a/class_graph.html#af765dda8f21280e1cecea19e129f1bc5">Graph::addEdge</a></div><div class="ttdeci">void addEdge(Edge const &amp;edge)</div><div class="ttdef"><b>Definition:</b> cycle_check_directed_graph.cpp:128</div></div>
<div class="ttc" id="afast__power_8cpp_html_a0d4e3f0099a6975b74a314a35bd0f94d"><div class="ttname"><a href="../../d2/d0b/fast__power_8cpp.html#a0d4e3f0099a6975b74a314a35bd0f94d">fast_power_linear</a></div><div class="ttdeci">double fast_power_linear(T a, T b)</div><div class="ttdef"><b>Definition:</b> fast_power.cpp:50</div></div>
<div class="ttc" id="anamespacespirograph_html_aeca22dbe4563358960e907a40cd3e1ac"><div class="ttname"><a href="../../da/dd3/namespacespirograph.html#aeca22dbe4563358960e907a40cd3e1ac">spirograph::spirograph</a></div><div class="ttdeci">void spirograph(std::array&lt; std::pair&lt; double, double &gt;, N &gt; *points, double l, double k, double rot)</div><div class="ttdef"><b>Definition:</b> spirograph.cpp:70</div></div>
<div class="ttc" id="abasic_istream_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/basic_istream.html">std::cin</a></div></div>
<div class="ttc" id="aclass_graph_html_ae30edce9b4e7c6347e67edc343f366d8"><div class="ttname"><a href="../../da/d9a/class_graph.html#ae30edce9b4e7c6347e67edc343f366d8">Graph::Graph</a></div><div class="ttdeci">Graph(unsigned int vertices, AdjList const &amp;adjList)</div><div class="ttdef"><b>Definition:</b> cycle_check_directed_graph.cpp:70</div></div>
<div class="ttc" id="aclasslarge__number_html_ac4fafa6289295419d48d444f0ae4b706"><div class="ttname"><a href="../../db/d82/classlarge__number.html#ac4fafa6289295419d48d444f0ae4b706">large_number::operator++</a></div><div class="ttdeci">large_number &amp; operator++(int)</div><div class="ttdef"><b>Definition:</b> large_number.h:183</div></div>