Skip to content

Commit 33bb755

Browse files
jenningsloy318jenningsloy318
committed
Documentation for 920b6d4 
1 parent 47d6423 commit 33bb755

File tree

37 files changed

+689
-183
lines changed

37 files changed

+689
-183
lines changed

‎d2/d90/namespacegreedy__algorithms.html

Lines changed: 30 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -125,19 +125,19 @@
125125
<tr class="memitem:a33e3819aa9ffec0e380383c52603b502" id="r_a33e3819aa9ffec0e380383c52603b502"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a33e3819aa9ffec0e380383c52603b502">can_jump</a> (const <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; int &gt; &amp;nums)</td></tr>
126126
<tr class="memdesc:a33e3819aa9ffec0e380383c52603b502"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks whether the given element (default is <code>1</code>) can jump to the last index. <br /></td></tr>
127127
<tr class="separator:a33e3819aa9ffec0e380383c52603b502"><td class="memSeparator" colspan="2">&#160;</td></tr>
128-
<tr class="memitem:a127ce4403660032f53ae2e6467e5427d" id="r_a127ce4403660032f53ae2e6467e5427d"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
129-
<tr class="memitem:a127ce4403660032f53ae2e6467e5427d"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a127ce4403660032f53ae2e6467e5427d">findMinimumEdge</a> (const int &amp;infinity, const <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/array.html">std::array</a>&lt; <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/array.html">std::array</a>&lt; T, 6 &gt;, 6 &gt; &amp;graph)</td></tr>
130-
<tr class="memdesc:a127ce4403660032f53ae2e6467e5427d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finds the minimum edge of the given graph. <br /></td></tr>
131-
<tr class="separator:a127ce4403660032f53ae2e6467e5427d"><td class="memSeparator" colspan="2">&#160;</td></tr>
128+
<tr class="memitem:a349e4ab9a97532c3931a2bd2a19c0098" id="r_a349e4ab9a97532c3931a2bd2a19c0098"><td class="memTemplParams" colspan="2">template&lt;typename T , <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> N, <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> M&gt; </td></tr>
129+
<tr class="memitem:a349e4ab9a97532c3931a2bd2a19c0098"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a349e4ab9a97532c3931a2bd2a19c0098">findMinimumEdge</a> (const T &amp;infinity, const <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/array.html">std::array</a>&lt; <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/array.html">std::array</a>&lt; T, N &gt;, M &gt; &amp;graph)</td></tr>
130+
<tr class="memdesc:a349e4ab9a97532c3931a2bd2a19c0098"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finds the minimum edge of the given graph. <br /></td></tr>
131+
<tr class="separator:a349e4ab9a97532c3931a2bd2a19c0098"><td class="memSeparator" colspan="2">&#160;</td></tr>
132132
</table>
133133
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
134134
<div class="textblock"><p>for <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a> </p>
135-
<p>for IO operations</p>
135+
<p>for uint32_t</p>
136136
<p>for assert for INT_MAX for IO operations</p>
137137
<p>Greedy Algorithms</p>
138138
<p>for assert for <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a></p>
139139
<p>Greedy Algorithms</p>
140-
<p>for array</p>
140+
<p>for array for IO operations for numeric limits</p>
141141
<p>Greedy Algorithms </p>
142142
</div><h2 class="groupheader">Function Documentation</h2>
143143
<a id="a33e3819aa9ffec0e380383c52603b502" name="a33e3819aa9ffec0e380383c52603b502"></a>
@@ -183,23 +183,23 @@ <h2 class="memtitle"><span class="permalink"><a href="#a33e3819aa9ffec0e380383c5
183183

184184
</div>
185185
</div>
186-
<a id="a127ce4403660032f53ae2e6467e5427d" name="a127ce4403660032f53ae2e6467e5427d"></a>
187-
<h2 class="memtitle"><span class="permalink"><a href="#a127ce4403660032f53ae2e6467e5427d">&#9670;&#160;</a></span>findMinimumEdge()</h2>
186+
<a id="a349e4ab9a97532c3931a2bd2a19c0098" name="a349e4ab9a97532c3931a2bd2a19c0098"></a>
187+
<h2 class="memtitle"><span class="permalink"><a href="#a349e4ab9a97532c3931a2bd2a19c0098">&#9670;&#160;</a></span>findMinimumEdge()</h2>
188188

189189
<div class="memitem">
190190
<div class="memproto">
191191
<div class="memtemplate">
192-
template&lt;typename T &gt; </div>
192+
template&lt;typename T , <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> N, <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> M&gt; </div>
193193
<table class="memname">
194194
<tr>
195195
<td class="memname">void greedy_algorithms::findMinimumEdge </td>
196196
<td>(</td>
197-
<td class="paramtype">const int &amp;</td> <td class="paramname"><span class="paramname"><em>infinity</em></span>, </td>
197+
<td class="paramtype">const T &amp;</td> <td class="paramname"><span class="paramname"><em>infinity</em></span>, </td>
198198
</tr>
199199
<tr>
200200
<td class="paramkey"></td>
201201
<td></td>
202-
<td class="paramtype">const <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/array.html">std::array</a>&lt; <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/array.html">std::array</a>&lt; T, 6 &gt;, 6 &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>graph</em></span>&#160;)</td>
202+
<td class="paramtype">const <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/array.html">std::array</a>&lt; <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/array.html">std::array</a>&lt; T, N &gt;, M &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>graph</em></span>&#160;)</td>
203203
</tr>
204204
</table>
205205
</div><div class="memdoc">
@@ -213,20 +213,25 @@ <h2 class="memtitle"><span class="permalink"><a href="#a127ce4403660032f53ae2e64
213213
</dd>
214214
</dl>
215215
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
216-
<div class="fragment"><div class="line"><span class="lineno"> 37</span> {</div>
217-
<div class="line"><span class="lineno"> 38</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; <a class="code hl_namespace" href="../../df/dce/namespacegraph.html">graph</a>.size(); i++) {</div>
218-
<div class="line"><span class="lineno"> 39</span> <span class="keywordtype">int</span> min = infinity;</div>
219-
<div class="line"><span class="lineno"> 40</span> <span class="keywordtype">int</span> minIndex = 0;</div>
220-
<div class="line"><span class="lineno"> 41</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> j = 0; j &lt; <a class="code hl_namespace" href="../../df/dce/namespacegraph.html">graph</a>.size(); j++) {</div>
221-
<div class="line"><span class="lineno"> 42</span> <span class="keywordflow">if</span> (<a class="code hl_namespace" href="../../df/dce/namespacegraph.html">graph</a>[i][j] != 0 &amp;&amp; <a class="code hl_namespace" href="../../df/dce/namespacegraph.html">graph</a>[i][j] &lt; min) {</div>
222-
<div class="line"><span class="lineno"> 43</span> min = <a class="code hl_namespace" href="../../df/dce/namespacegraph.html">graph</a>[i][j];</div>
223-
<div class="line"><span class="lineno"> 44</span> minIndex = j;</div>
224-
<div class="line"><span class="lineno"> 45</span> }</div>
225-
<div class="line"><span class="lineno"> 46</span> }</div>
226-
<div class="line"><span class="lineno"> 47</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; i &lt;&lt; <span class="stringliteral">&quot; - &quot;</span> &lt;&lt; minIndex &lt;&lt; <span class="stringliteral">&quot;\t&quot;</span> &lt;&lt; <a class="code hl_namespace" href="../../df/dce/namespacegraph.html">graph</a>[i][minIndex]</div>
227-
<div class="line"><span class="lineno"> 48</span> &lt;&lt; <span class="stringliteral">&quot;\n&quot;</span>;</div>
228-
<div class="line"><span class="lineno"> 49</span> }</div>
229-
<div class="line"><span class="lineno"> 50</span>}</div>
216+
<div class="fragment"><div class="line"><span class="lineno"> 39</span> {</div>
217+
<div class="line"><span class="lineno"> 40</span> <span class="keywordflow">if</span> (N != M) {</div>
218+
<div class="line"><span class="lineno"> 41</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;\nWrong input passed. Provided array has dimensions &quot;</span> &lt;&lt; N</div>
219+
<div class="line"><span class="lineno"> 42</span> &lt;&lt; <span class="stringliteral">&quot;x&quot;</span> &lt;&lt; M &lt;&lt; <span class="stringliteral">&quot;. Please provide a square matrix.\n&quot;</span>;</div>
220+
<div class="line"><span class="lineno"> 43</span> <span class="keywordflow">return</span>;</div>
221+
<div class="line"><span class="lineno"> 44</span> }</div>
222+
<div class="line"><span class="lineno"> 45</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; <a class="code hl_namespace" href="../../df/dce/namespacegraph.html">graph</a>.size(); i++) {</div>
223+
<div class="line"><span class="lineno"> 46</span> <span class="keywordtype">int</span> min = infinity;</div>
224+
<div class="line"><span class="lineno"> 47</span> <span class="keywordtype">int</span> minIndex = 0;</div>
225+
<div class="line"><span class="lineno"> 48</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> j = 0; j &lt; <a class="code hl_namespace" href="../../df/dce/namespacegraph.html">graph</a>.size(); j++) {</div>
226+
<div class="line"><span class="lineno"> 49</span> <span class="keywordflow">if</span> (i != j &amp;&amp; <a class="code hl_namespace" href="../../df/dce/namespacegraph.html">graph</a>[i][j] != 0 &amp;&amp; <a class="code hl_namespace" href="../../df/dce/namespacegraph.html">graph</a>[i][j] &lt; min) {</div>
227+
<div class="line"><span class="lineno"> 50</span> min = <a class="code hl_namespace" href="../../df/dce/namespacegraph.html">graph</a>[i][j];</div>
228+
<div class="line"><span class="lineno"> 51</span> minIndex = j;</div>
229+
<div class="line"><span class="lineno"> 52</span> }</div>
230+
<div class="line"><span class="lineno"> 53</span> }</div>
231+
<div class="line"><span class="lineno"> 54</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; i &lt;&lt; <span class="stringliteral">&quot; - &quot;</span> &lt;&lt; minIndex &lt;&lt; <span class="stringliteral">&quot;\t&quot;</span> &lt;&lt; <a class="code hl_namespace" href="../../df/dce/namespacegraph.html">graph</a>[i][minIndex]</div>
232+
<div class="line"><span class="lineno"> 55</span> &lt;&lt; <span class="stringliteral">&quot;\n&quot;</span>;</div>
233+
<div class="line"><span class="lineno"> 56</span> }</div>
234+
<div class="line"><span class="lineno"> 57</span>}</div>
230235
<div class="ttc" id="abasic_ostream_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a></div></div>
231236
<div class="ttc" id="anamespacegraph_html"><div class="ttname"><a href="../../df/dce/namespacegraph.html">graph</a></div><div class="ttdoc">Graph Algorithms.</div></div>
232237
</div><!-- fragment -->

‎d2/d90/namespacegreedy__algorithms.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@ var namespacegreedy__algorithms =
22
[
33
[ "dijkstra", "d2/d2f/namespacegreedy__algorithms_1_1dijkstra.html", "d2/d2f/namespacegreedy__algorithms_1_1dijkstra" ],
44
[ "can_jump", "d2/d90/namespacegreedy__algorithms.html#a33e3819aa9ffec0e380383c52603b502", null ],
5-
[ "findMinimumEdge", "d2/d90/namespacegreedy__algorithms.html#a127ce4403660032f53ae2e6467e5427d", null ]
5+
[ "findMinimumEdge", "d2/d90/namespacegreedy__algorithms.html#a349e4ab9a97532c3931a2bd2a19c0098", null ]
66
];

‎d4/db6/reverse__binary__tree_8cpp.html

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -184,11 +184,11 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae66f6b31b5ad750f1fe042a7
184184

185185
<p>main function </p>
186186
<dl class="section return"><dt>Returns</dt><dd>0 on exit </dd></dl>
187-
<div class="fragment"><div class="line"><span class="lineno"> 252</span> {</div>
188-
<div class="line"><span class="lineno"> 253</span> <a class="code hl_function" href="#aa8dca7b867074164d5f45b0f3851269d">test</a>(); <span class="comment">// run self-test implementations</span></div>
189-
<div class="line"><span class="lineno"> 254</span> <span class="keywordflow">return</span> 0;</div>
190-
<div class="line"><span class="lineno"> 255</span>}</div>
191-
<div class="ttc" id="areverse__binary__tree_8cpp_html_aa8dca7b867074164d5f45b0f3851269d"><div class="ttname"><a href="#aa8dca7b867074164d5f45b0f3851269d">test</a></div><div class="ttdeci">static void test()</div><div class="ttdoc">Function to test the correctness of the Tree Reversal.</div><div class="ttdef"><b>Definition</b> reverse_binary_tree.cpp:242</div></div>
187+
<div class="fragment"><div class="line"><span class="lineno"> 270</span> {</div>
188+
<div class="line"><span class="lineno"> 271</span> <a class="code hl_function" href="#aa8dca7b867074164d5f45b0f3851269d">test</a>(); <span class="comment">// run self-test implementations</span></div>
189+
<div class="line"><span class="lineno"> 272</span> <span class="keywordflow">return</span> 0;</div>
190+
<div class="line"><span class="lineno"> 273</span>}</div>
191+
<div class="ttc" id="areverse__binary__tree_8cpp_html_aa8dca7b867074164d5f45b0f3851269d"><div class="ttname"><a href="#aa8dca7b867074164d5f45b0f3851269d">test</a></div><div class="ttdeci">static void test()</div><div class="ttdoc">Function to test the correctness of the Tree Reversal.</div><div class="ttdef"><b>Definition</b> reverse_binary_tree.cpp:260</div></div>
192192
</div><!-- fragment --><div class="dynheader">
193193
Here is the call graph for this function:</div>
194194
<div class="dyncontent">
@@ -224,11 +224,11 @@ <h2 class="memtitle"><span class="permalink"><a href="#aa8dca7b867074164d5f45b0f
224224
<p>&lt; Single element test</p>
225225
<p>&lt; No element test</p>
226226
<p>&lt; Correct reversal test</p>
227-
<div class="fragment"><div class="line"><span class="lineno"> 242</span> {</div>
228-
<div class="line"><span class="lineno"> 243</span> <a class="code hl_function" href="../../d9/df4/namespacetests.html#a167c24bd817469ae47358d12e034f2d5">tests::test1</a>(); <span class="comment">///&lt; Single element test</span></div>
229-
<div class="line"><span class="lineno"> 244</span> <a class="code hl_function" href="../../d9/df4/namespacetests.html#abdd77344d4af8fd56d14a5cabbf2f669">tests::test2</a>(); <span class="comment">///&lt; No element test</span></div>
230-
<div class="line"><span class="lineno"> 245</span> <a class="code hl_function" href="../../d9/df4/namespacetests.html#aa515639572647508b94986489aab6d76">tests::test3</a>(); <span class="comment">///&lt; Correct reversal test</span></div>
231-
<div class="line"><span class="lineno"> 246</span>}</div>
227+
<div class="fragment"><div class="line"><span class="lineno"> 260</span> {</div>
228+
<div class="line"><span class="lineno"> 261</span> <a class="code hl_function" href="../../d9/df4/namespacetests.html#a167c24bd817469ae47358d12e034f2d5">tests::test1</a>(); <span class="comment">///&lt; Single element test</span></div>
229+
<div class="line"><span class="lineno"> 262</span> <a class="code hl_function" href="../../d9/df4/namespacetests.html#abdd77344d4af8fd56d14a5cabbf2f669">tests::test2</a>(); <span class="comment">///&lt; No element test</span></div>
230+
<div class="line"><span class="lineno"> 263</span> <a class="code hl_function" href="../../d9/df4/namespacetests.html#aa515639572647508b94986489aab6d76">tests::test3</a>(); <span class="comment">///&lt; Correct reversal test</span></div>
231+
<div class="line"><span class="lineno"> 264</span>}</div>
232232
<div class="ttc" id="anamespacetests_html_a167c24bd817469ae47358d12e034f2d5"><div class="ttname"><a href="../../d9/df4/namespacetests.html#a167c24bd817469ae47358d12e034f2d5">tests::test1</a></div><div class="ttdeci">void test1()</div><div class="ttdoc">A Test to check an simple case.</div><div class="ttdef"><b>Definition</b> array_left_rotation.cpp:75</div></div>
233233
<div class="ttc" id="anamespacetests_html_aa515639572647508b94986489aab6d76"><div class="ttname"><a href="../../d9/df4/namespacetests.html#aa515639572647508b94986489aab6d76">tests::test3</a></div><div class="ttdeci">void test3()</div><div class="ttdoc">A Test to check an invalid shift value.</div><div class="ttdef"><b>Definition</b> array_left_rotation.cpp:105</div></div>
234234
<div class="ttc" id="anamespacetests_html_abdd77344d4af8fd56d14a5cabbf2f669"><div class="ttname"><a href="../../d9/df4/namespacetests.html#abdd77344d4af8fd56d14a5cabbf2f669">tests::test2</a></div><div class="ttdeci">void test2()</div><div class="ttdoc">A Test to check an empty vector.</div><div class="ttdef"><b>Definition</b> array_left_rotation.cpp:90</div></div>

0 commit comments

Comments
 (0)