API documentation update by build server

Author: buildbot121

docs/api/Advanced.Algorithms.Binary.Gcd.html

@@ -83,7 +83,8 @@
 
   <h1 id="Advanced_Algorithms_Binary_Gcd" data-uid="Advanced.Algorithms.Binary.Gcd" class="text-break">Class Gcd
   </h1>
-  <div class="markdown level0 summary"></div>
+  <div class="markdown level0 summary"><p>GCD without division or mod operators but using substraction.</p>
+</div>
   <div class="markdown level0 conceptual"></div>
   <div class="inheritance">
     <h5>Inheritance</h5>

docs/api/Advanced.Algorithms.Binary.html

@@ -90,7 +90,8 @@ <h3 id="classes">Classes
       <h4><a class="xref" href="Advanced.Algorithms.Binary.BaseConversion.html">BaseConversion</a></h4>
       <section></section>
       <h4><a class="xref" href="Advanced.Algorithms.Binary.Gcd.html">Gcd</a></h4>
-      <section></section>
+      <section><p>GCD without division or mod operators but using substraction.</p>
+</section>
       <h4><a class="xref" href="Advanced.Algorithms.Binary.Logarithm.html">Logarithm</a></h4>
       <section></section>
 </article>

docs/api/Advanced.Algorithms.Compression.HuffmanCoding-1.html

@@ -83,7 +83,7 @@
 
   <h1 id="Advanced_Algorithms_Compression_HuffmanCoding_1" data-uid="Advanced.Algorithms.Compression.HuffmanCoding`1" class="text-break">Class HuffmanCoding&lt;T&gt;
   </h1>
-  <div class="markdown level0 summary"><p>A huffman coding implementation using Fibornacci Min Heap</p>
+  <div class="markdown level0 summary"><p>A huffman coding implementation using Fibornacci Min Heap.</p>
 </div>
   <div class="markdown level0 conceptual"></div>
   <div class="inheritance">
@@ -142,7 +142,7 @@ <h3 id="methods">Methods
 
   <a id="Advanced_Algorithms_Compression_HuffmanCoding_1_Compress_" data-uid="Advanced.Algorithms.Compression.HuffmanCoding`1.Compress*"></a>
   <h4 id="Advanced_Algorithms_Compression_HuffmanCoding_1_Compress__0___" data-uid="Advanced.Algorithms.Compression.HuffmanCoding`1.Compress(`0[])">Compress(T[])</h4>
-  <div class="markdown level1 summary"><p>Returns a dictionary of chosen encoding bytes for each distinct T</p>
+  <div class="markdown level1 summary"><p>Returns a dictionary of chosen encoding bytes for each distinct T.</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>

docs/api/Advanced.Algorithms.Compression.html

@@ -88,7 +88,7 @@ <h1 id="Advanced_Algorithms_Compression" data-uid="Advanced.Algorithms.Compressi
     <h3 id="classes">Classes
   </h3>
       <h4><a class="xref" href="Advanced.Algorithms.Compression.HuffmanCoding-1.html">HuffmanCoding&lt;T&gt;</a></h4>
-      <section><p>A huffman coding implementation using Fibornacci Min Heap</p>
+      <section><p>A huffman coding implementation using Fibornacci Min Heap.</p>
 </section>
 </article>
           </div>

docs/api/Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph-1.html

@@ -83,14 +83,20 @@
 
   <h1 id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1" data-uid="Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph`1" class="text-break">Class DiGraph&lt;T&gt;
   </h1>
-  <div class="markdown level0 summary"><p>A directed graph implementation</p>
+  <div class="markdown level0 summary"><p>A directed graph implementation.
+IEnumerable enumerates all vertices.</p>
 </div>
   <div class="markdown level0 conceptual"></div>
   <div class="inheritance">
     <h5>Inheritance</h5>
     <div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>
     <div class="level1"><span class="xref">DiGraph&lt;T&gt;</span></div>
   </div>
+  <div classs="implements">
+    <h5>Implements</h5>
+    <div><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;T&gt;</div>
+    <div><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.ienumerable">IEnumerable</a></div>
+  </div>
   <div class="inheritedMembers">
     <h5>Inherited Members</h5>
     <div>
@@ -119,7 +125,7 @@ <h6><strong>Namespace</strong>: <a class="xref" href="Advanced.Algorithms.DataSt
   <h6><strong>Assembly</strong>: Advanced.Algorithms.dll</h6>
   <h5 id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1_syntax">Syntax</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public class DiGraph&lt;T&gt;</code></pre>
+    <pre><code class="lang-csharp hljs">public class DiGraph&lt;T&gt; : IEnumerable&lt;T&gt;, IEnumerable</code></pre>
   </div>
   <h5 class="typeParameters">Type Parameters</h5>
   <table class="table table-bordered table-striped table-condensed">
@@ -142,8 +148,7 @@ <h3 id="constructors">Constructors
 
   <a id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1__ctor_" data-uid="Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph`1.#ctor*"></a>
   <h4 id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1__ctor" data-uid="Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph`1.#ctor">DiGraph()</h4>
-  <div class="markdown level1 summary"><p>Constructor</p>
-</div>
+  <div class="markdown level1 summary"></div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
@@ -155,8 +160,8 @@ <h3 id="properties">Properties
 
   <a id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1_ReferenceVertex_" data-uid="Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph`1.ReferenceVertex*"></a>
   <h4 id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1_ReferenceVertex" data-uid="Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph`1.ReferenceVertex">ReferenceVertex</h4>
-  <div class="markdown level1 summary"><p>return a reference vertex  to start traversing Vertices
-O(1) complexity</p>
+  <div class="markdown level1 summary"><p>Return a reference vertex to start traversing Vertices
+Time complexity: O(1).</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
@@ -209,8 +214,8 @@ <h3 id="methods">Methods
 
   <a id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1_AddEdge_" data-uid="Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph`1.AddEdge*"></a>
   <h4 id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1_AddEdge__0__0_" data-uid="Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph`1.AddEdge(`0,`0)">AddEdge(T, T)</h4>
-  <div class="markdown level1 summary"><p>add an edge from source to destination vertex
-O(1) complexity</p>
+  <div class="markdown level1 summary"><p>Add an edge from source to destination vertex.
+Time complexity: O(1).</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
@@ -243,8 +248,8 @@ <h5 class="parameters">Parameters</h5>
 
   <a id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1_AddVertex_" data-uid="Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph`1.AddVertex*"></a>
   <h4 id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1_AddVertex__0_" data-uid="Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph`1.AddVertex(`0)">AddVertex(T)</h4>
-  <div class="markdown level1 summary"><p>add a new vertex to this graph
-O(1) complexity</p>
+  <div class="markdown level1 summary"><p>Add a new vertex to this graph.
+Time complexity: O(1).</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
@@ -287,8 +292,8 @@ <h5 class="returns">Returns</h5>
 
   <a id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1_FindVertex_" data-uid="Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph`1.FindVertex*"></a>
   <h4 id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1_FindVertex__0_" data-uid="Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph`1.FindVertex(`0)">FindVertex(T)</h4>
-  <div class="markdown level1 summary"><p>returns the vertex object with given value
-O(1) complexity</p>
+  <div class="markdown level1 summary"><p>Returns the vertex object with given value.
+Time complexity: O(1).</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
@@ -329,13 +334,40 @@ <h5 class="returns">Returns</h5>
   </table>
 
 
-  <a id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1_GetAllInEdges_" data-uid="Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph`1.GetAllInEdges*"></a>
-  <h4 id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1_GetAllInEdges__0_" data-uid="Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph`1.GetAllInEdges(`0)">GetAllInEdges(T)</h4>
+  <a id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1_GetEnumerator_" data-uid="Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph`1.GetEnumerator*"></a>
+  <h4 id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1_GetEnumerator" data-uid="Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph`1.GetEnumerator">GetEnumerator()</h4>
   <div class="markdown level1 summary"></div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public List&lt;T&gt; GetAllInEdges(T vertex)</code></pre>
+    <pre><code class="lang-csharp hljs">public IEnumerator&lt;T&gt; GetEnumerator()</code></pre>
+  </div>
+  <h5 class="returns">Returns</h5>
+  <table class="table table-bordered table-striped table-condensed">
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.ienumerator-1">IEnumerator</a>&lt;T&gt;</td>
+        <td></td>
+      </tr>
+    </tbody>
+  </table>
+  
+  
+  <a id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1_HasEdge_" data-uid="Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph`1.HasEdge*"></a>
+  <h4 id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1_HasEdge__0__0_" data-uid="Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph`1.HasEdge(`0,`0)">HasEdge(T, T)</h4>
+  <div class="markdown level1 summary"><p>Do we have an edge between the given source and destination?
+Time complexity: O(1).</p>
+</div>
+  <div class="markdown level1 conceptual"></div>
+  <h5 class="decalaration">Declaration</h5>
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public bool HasEdge(T source, T dest)</code></pre>
   </div>
   <h5 class="parameters">Parameters</h5>
   <table class="table table-bordered table-striped table-condensed">
@@ -349,7 +381,12 @@ <h5 class="parameters">Parameters</h5>
     <tbody>
       <tr>
         <td><span class="xref">T</span></td>
-        <td><span class="parametername">vertex</span></td>
+        <td><span class="parametername">source</span></td>
+        <td></td>
+      </tr>
+      <tr>
+        <td><span class="xref">T</span></td>
+        <td><span class="parametername">dest</span></td>
         <td></td>
       </tr>
     </tbody>
@@ -364,20 +401,20 @@ <h5 class="returns">Returns</h5>
     </thead>
     <tbody>
       <tr>
-        <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;T&gt;</td>
+        <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
         <td></td>
       </tr>
     </tbody>
   </table>
 
 
-  <a id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1_GetAllOutEdges_" data-uid="Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph`1.GetAllOutEdges*"></a>
-  <h4 id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1_GetAllOutEdges__0_" data-uid="Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph`1.GetAllOutEdges(`0)">GetAllOutEdges(T)</h4>
+  <a id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1_InEdges_" data-uid="Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph`1.InEdges*"></a>
+  <h4 id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1_InEdges__0_" data-uid="Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph`1.InEdges(`0)">InEdges(T)</h4>
   <div class="markdown level1 summary"></div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public List&lt;T&gt; GetAllOutEdges(T vertex)</code></pre>
+    <pre><code class="lang-csharp hljs">public IEnumerable&lt;T&gt; InEdges(T vertex)</code></pre>
   </div>
   <h5 class="parameters">Parameters</h5>
   <table class="table table-bordered table-striped table-condensed">
@@ -406,22 +443,20 @@ <h5 class="returns">Returns</h5>
     </thead>
     <tbody>
       <tr>
-        <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;T&gt;</td>
+        <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;T&gt;</td>
         <td></td>
       </tr>
     </tbody>
   </table>
 
 
-  <a id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1_HasEdge_" data-uid="Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph`1.HasEdge*"></a>
-  <h4 id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1_HasEdge__0__0_" data-uid="Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph`1.HasEdge(`0,`0)">HasEdge(T, T)</h4>
-  <div class="markdown level1 summary"><p>do we have an edge between the given source and destination?
-O(1) complexity</p>
-</div>
+  <a id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1_OutEdges_" data-uid="Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph`1.OutEdges*"></a>
+  <h4 id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1_OutEdges__0_" data-uid="Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph`1.OutEdges(`0)">OutEdges(T)</h4>
+  <div class="markdown level1 summary"></div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public bool HasEdge(T source, T dest)</code></pre>
+    <pre><code class="lang-csharp hljs">public IEnumerable&lt;T&gt; OutEdges(T vertex)</code></pre>
   </div>
   <h5 class="parameters">Parameters</h5>
   <table class="table table-bordered table-striped table-condensed">
@@ -435,12 +470,7 @@ <h5 class="parameters">Parameters</h5>
     <tbody>
       <tr>
         <td><span class="xref">T</span></td>
-        <td><span class="parametername">source</span></td>
-        <td></td>
-      </tr>
-      <tr>
-        <td><span class="xref">T</span></td>
-        <td><span class="parametername">dest</span></td>
+        <td><span class="parametername">vertex</span></td>
         <td></td>
       </tr>
     </tbody>
@@ -455,7 +485,7 @@ <h5 class="returns">Returns</h5>
     </thead>
     <tbody>
       <tr>
-        <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
+        <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;T&gt;</td>
         <td></td>
       </tr>
     </tbody>
@@ -496,8 +526,8 @@ <h5 class="parameters">Parameters</h5>
 
   <a id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1_RemoveVertex_" data-uid="Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph`1.RemoveVertex*"></a>
   <h4 id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1_RemoveVertex__0_" data-uid="Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph`1.RemoveVertex(`0)">RemoveVertex(T)</h4>
-  <div class="markdown level1 summary"><p>remove an existing vertex frm graph
-O(V) complexity</p>
+  <div class="markdown level1 summary"><p>Remove an existing vertex frm graph.
+Time complexity: O(V) where V is the total number of vertices in this graph.</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
@@ -521,6 +551,40 @@ <h5 class="parameters">Parameters</h5>
       </tr>
     </tbody>
   </table>
+  <h3 id="eii">Explicit Interface Implementations
+  </h3>
+  
+  
+  <a id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1_System_Collections_IEnumerable_GetEnumerator_" data-uid="Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph`1.System#Collections#IEnumerable#GetEnumerator*"></a>
+  <h4 id="Advanced_Algorithms_DataStructures_Graph_AdjacencyList_DiGraph_1_System_Collections_IEnumerable_GetEnumerator" data-uid="Advanced.Algorithms.DataStructures.Graph.AdjacencyList.DiGraph`1.System#Collections#IEnumerable#GetEnumerator">IEnumerable.GetEnumerator()</h4>
+  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 conceptual"></div>
+  <h5 class="decalaration">Declaration</h5>
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">IEnumerator IEnumerable.GetEnumerator()</code></pre>
+  </div>
+  <h5 class="returns">Returns</h5>
+  <table class="table table-bordered table-striped table-condensed">
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.ienumerator">IEnumerator</a></td>
+        <td></td>
+      </tr>
+    </tbody>
+  </table>
+  <h3 id="implements">Implements</h3>
+  <div>
+      <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">System.Collections.Generic.IEnumerable&lt;T&gt;</a>
+  </div>
+  <div>
+      <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.ienumerable">System.Collections.IEnumerable</a>
+  </div>
 </article>
           </div>