Merge pull request #18 from justcoding121/master

Beta

Author: justcoding121

Advanced.Algorithms/Graph/Bridge/TarjansBridgeFinder.cs

@@ -77,6 +77,9 @@ private List<Bridge<T>> dfs(GraphVertex<T> currentVertex,
         }
     }
 
+    /// <summary>
+    /// The bridge object.
+    /// </summary>
     public class Bridge<T>
     {
         public T vertexA { get; }

Advanced.Algorithms/Graph/Coloring/MColorer.cs

@@ -3,7 +3,9 @@
 
 namespace Advanced.Algorithms.Graph
 {
-
+    /// <summary>
+    /// An m-coloring algorithm implementation.
+    /// </summary>
     public class MColorer<T, C>
     {
         /// <summary>

Advanced.Algorithms/Graph/Cover/MinVertexCover.cs

@@ -3,6 +3,9 @@
 
 namespace Advanced.Algorithms.Graph
 {
+    /// <summary>
+    /// A minimum vertex conver algorithm implementation.
+    /// </summary>
     public class MinVertexCover<T>
     {
         public List<GraphVertex<T>> GetMinVertexCover(Graph<T> graph)

Advanced.Algorithms/Graph/Cut/MinimumCut.cs

@@ -87,6 +87,9 @@ private void dfs(WeightedDiGraphVertex<T, W> currentResidualGraphVertex,
         }
     }
 
+    /// <summary>
+    /// Minimum cut result object.
+    /// </summary>
     public class MinCutEdge<T>
     {
         public T Source { get; }

Advanced.Algorithms/Graph/Flow/EdmondsKarp.cs

@@ -6,7 +6,7 @@ namespace Advanced.Algorithms.Graph
 {
 
     /// <summary>
-    /// A Edmond Karp max flox implementation on weighted directed graph using 
+    /// An Edmond Karp max flow implementation on weighted directed graph using 
     /// adjacency list representation of graph & residual graph.
     /// </summary>
     public class EdmondKarpMaxFlow<T, W> where W : IComparable

Advanced.Algorithms/Graph/Matching/BiPartiteMatching.cs

@@ -109,6 +109,9 @@ private static WeightedDiGraph<T, int> createFlowGraph(Graph<T> graph,
         }
     }
 
+    /// <summary>
+    /// The match result object.
+    /// </summary>
     public class MatchEdge<T>
     {
         public T Source { get; }

Advanced.Algorithms/Graph/ShortestPath/Floyd-Warshall.cs

@@ -4,6 +4,9 @@
 
 namespace Advanced.Algorithms.Graph
 {
+    /// <summary>
+    /// A floyd-warshall shortest path algorithm implementation.
+    /// </summary>
     public class FloydWarshallShortestPath<T, W> where W : IComparable
     {
         readonly IShortestPathOperators<W> operators;

Advanced.Algorithms/Graph/ShortestPath/Johnsons.cs

@@ -6,6 +6,9 @@
 
 namespace Advanced.Algorithms.Graph
 { 
+    /// <summary>
+    /// A Johnson's shortest path algorithm implementation.
+    /// </summary>
     public class JohnsonsShortestPath<T, W> where W : IComparable
     {
         readonly IJohnsonsShortestPathOperators<T, W> operators;

Advanced.Algorithms/Numerical/Exponentiation.cs

@@ -1,5 +1,8 @@
 namespace Advanced.Algorithms.Numerical
 {
+    /// <summary>
+    /// A fast exponentiation algorithm implementation.
+    /// </summary>
     public class FastExponentiation
     {
         /// <summary>

Advanced.Algorithms/Numerical/PrimeGenerator.cs

@@ -3,11 +3,11 @@
 
 namespace Advanced.Algorithms.Numerical
 {
+    /// <summary>
+    /// A prime number generation algorithm using Sieve of Eratosthenes.
+    /// </summary>
     public class PrimeGenerator
     {
-        /// <summary>
-        /// Prime generation using Sieve of Eratosthenes.
-        /// </summary>
         public static List<int> GetAllPrimes(int max)
         {
             var primeTable = new bool[max + 1];

Advanced.Algorithms/Search/BinarySearch.cs

@@ -1,5 +1,8 @@
 namespace Advanced.Algorithms.Search
 {
+    /// <summary>
+    /// A binary search algorithm implementation.
+    /// </summary>
     public class BinarySearch
     {
         public static int Search(int[] input, int element)

Advanced.Algorithms/Search/BoyerMoore.cs

@@ -4,6 +4,10 @@
 
 namespace Advanced.Algorithms.Search
 {
+    /// <summary>
+    /// A boyer-moore majority finder algorithm implementation.
+    /// </summary>
+    /// <typeparam name="T"></typeparam>
     public class BoyerMoore<T> where T : IComparable
     {
         public static T FindMajority(IEnumerable<T> input)

Advanced.Algorithms/Search/QuickSelect.cs

@@ -5,6 +5,10 @@
 
 namespace Advanced.Algorithms.Search
 {
+    /// <summary>
+    /// A quick select for Kth smallest algorithm implementation.
+    /// </summary>
+    /// <typeparam name="T"></typeparam>
     public class QuickSelect<T> where T : IComparable
     {
         public static T FindSmallest(IEnumerable<T> input, int k)

Advanced.Algorithms/Sorting/BubbleSort.cs

@@ -2,6 +2,9 @@
 
 namespace Advanced.Algorithms.Sorting
 {
+    /// <summary>
+    /// A bubble sort implementation.
+    /// </summary>
     public class BubbleSort<T> where T : IComparable
     {
         /// <summary>

Advanced.Algorithms/Sorting/HeapSort.cs

@@ -3,6 +3,9 @@
 
 namespace Advanced.Algorithms.Sorting
 {
+    /// <summary>
+    /// A heap sort implementation.
+    /// </summary>
     public class HeapSort<T> where T : IComparable
     {
         /// <summary>

Advanced.Algorithms/Sorting/InsertionSort.cs

@@ -2,6 +2,10 @@
 
 namespace Advanced.Algorithms.Sorting
 {
+    /// <summary>
+    /// An insertion sort implementation.
+    /// </summary>
+    /// <typeparam name="T"></typeparam>
     public class InsertionSort<T> where T : IComparable
     {
         /// <summary>

Advanced.Algorithms/Sorting/MergeSort.cs

@@ -2,6 +2,9 @@
 
 namespace Advanced.Algorithms.Sorting
 {
+    /// <summary>
+    /// A merge sort implementation.
+    /// </summary>
     public class MergeSort<T> where T : IComparable
     {
         /// <summary>

Advanced.Algorithms/Sorting/QuickSort.cs

@@ -2,6 +2,9 @@
 
 namespace Advanced.Algorithms.Sorting
 {
+    /// <summary>
+    /// A quick sort implementation.
+    /// </summary>
     public class QuickSort<T> where T : IComparable
     {
         /// <summary>

Advanced.Algorithms/Sorting/SelectionSort.cs

@@ -2,6 +2,9 @@
 
 namespace Advanced.Algorithms.Sorting
 {
+    /// <summary>
+    /// A selection sort implementation.
+    /// </summary>
     public class SelectionSort<T> where T : IComparable
     {
         /// <summary>

Advanced.Algorithms/Sorting/ShellSort.cs

@@ -2,7 +2,6 @@
 
 namespace Advanced.Algorithms.Sorting
 {
-
     /// <summary>
     /// A shell sort implementation.
     /// </summary>

Advanced.Algorithms/Sorting/TreeSort.cs

@@ -3,6 +3,9 @@
 
 namespace Advanced.Algorithms.Sorting
 {
+    /// <summary>
+    /// A tree sort implementation.
+    /// </summary>
     public class TreeSort<T> where T : IComparable
     {
         /// <summary>

Advanced.Algorithms/String/Search/KMP.cs

@@ -1,7 +1,7 @@
 namespace Advanced.Algorithms.String
 {
     /// <summary>
-    /// Knuth–Morris–Pratt(KMP) search implementation.
+    /// Knuth–Morris–Pratt(KMP) string search implementation.
     /// </summary>
     public class KMP
     {

Advanced.Algorithms/String/Search/RabinKarp.cs

@@ -2,6 +2,9 @@
 
 namespace Advanced.Algorithms.String
 {
+    /// <summary>
+    /// A Rabin-Karp string search implementation.
+    /// </summary>
     public class RabinKarp
     {
         /// <summary>

Advanced.Algorithms/String/Search/ZAlgorithm.cs

@@ -1,5 +1,8 @@
 namespace Advanced.Algorithms.String
 {
+    /// <summary>
+    /// A Z-algorithm implementation for string search.
+    /// </summary>
     public class ZAlgorithm
     {
         /// <summary>