Merge branch 'main' into branch-RefactorKMP

Author: 4ndrelim

README.md

@@ -34,7 +34,7 @@ Gradle is used for development.
   - [Monotonic Queue](src/main/java/dataStructures/queue/monotonicQueue)
 - Segment Tree
 - [Stack](src/main/java/dataStructures/stack)
-- Trie
+- [Trie](src/main/java/dataStructures/trie)
 
 ## Algorithms
 - [Bubble Sort](src/main/java/algorithms/sorting/bubbleSort)
@@ -81,9 +81,9 @@ Gradle is used for development.
     * [Binary search tree](src/main/java/dataStructures/binarySearchTree)
     * AVL-tree
     * Orthogonal Range Searching
-    * Trie
+    * [Trie](src/main/java/dataStructures/trie)
     * B-Tree
-    * * Red-Black Tree (Not covered in CS2040s but useful!)
+    * Red-Black Tree (Not covered in CS2040s but useful!)
     * Kd-tree (**WIP**)
     * Interval tree (**WIP**)
 5. [Binary Heap](src/main/java/dataStructures/heap) (Max heap)

docs/assets/images/Trie.png

@@ -9,6 +9,8 @@ in text editors when searching for a pattern, in computational biology sequence
 in NLP problems, and even for looking for file patterns for effective file management.
 It is hence crucial that we develop an efficient algorithm.
 
+Typically, the algorithm returns a list of indices that denote the start of each occurrence of the pattern string.
+
 ![KMP](../../../../../docs/assets/images/kmp.png)
 Image Source: GeeksforGeeks
 

src/main/java/algorithms/patternFinding/README.md

@@ -1,5 +1,5 @@
 # Quick Union
-
+If you wish to jump to [weighted union](#Weighted-Union).
 ## Background
 Here, we consider a completely different approach. We consider the use of trees. Every element can be
 thought of as a tree node and starts off in its own component. Under this representation, it is likely

src/main/java/dataStructures/disjointSet/weightedUnion/README.md

@@ -67,7 +67,7 @@ public HashSet() {
      * @return the number of elements in this set (its cardinality)
      */
     public int size() {
-        return this.size;
+        return size;
     }
 
     /**
@@ -76,13 +76,12 @@ public int size() {
      * @return true if this set contains no elements
      */
     public boolean isEmpty() {
-        return this.size() == 0;
+        return size() == 0;
     }
 
     /**
-     * TODO formal documentation.
      * Simple hash function to hash the element into their respective bucket.
-     * Currently uses the division method (k % m).
+     * Currently, uses the division method (k % m).
      * T must override both Object::equals and Object::hashCode.
      *
      * @param element the specified element to be hashed.
@@ -104,12 +103,12 @@ private int hashFunction(T element) {
      *     element
      */
     public boolean add(T element) {
-        int bucket = this.hashFunction(element);
-        LinkedList<T> bucketLinkedList = this.buckets[bucket];
+        int bucket = hashFunction(element);
+        LinkedList<T> bucketLinkedList = buckets[bucket];
         if (bucketLinkedList.search(element) != -1) {
             return false; // element is already in the set.
         }
-        ++this.size; // updates the cardinality of this hashset.
+        ++size; // updates the cardinality of this hashset.
         return bucketLinkedList.insertFront(element);
     }
 
@@ -120,8 +119,8 @@ public boolean add(T element) {
      * @return true if this set contains the specified element
      */
     public boolean contains(T element) {
-        int bucket = this.hashFunction(element);
-        LinkedList<T> bucketLinkedList = this.buckets[bucket];
+        int bucket = hashFunction(element);
+        LinkedList<T> bucketLinkedList = buckets[bucket];
         return bucketLinkedList.search(element) != -1;
     }
 
@@ -137,14 +136,14 @@ public boolean contains(T element) {
      * @return true if this set contained the specified element
      */
     public boolean remove(T element) {
-        int bucket = this.hashFunction(element);
-        LinkedList<T> bucketLinkedList = this.buckets[bucket];
+        int bucket = hashFunction(element);
+        LinkedList<T> bucketLinkedList = buckets[bucket];
         int index = bucketLinkedList.search(element);
         if (index == -1) {
             return false; // If the element is not in the hashset.
         }
         bucketLinkedList.remove(index);
-        --this.size; // updates the cardinality of the hash set.
+        --size; // updates the cardinality of the hash set.
         return true;
     }
 
@@ -155,7 +154,7 @@ public boolean remove(T element) {
      */
     public List<T> toList() {
         List<T> outputList = new ArrayList<>();
-        for (LinkedList<T> bucket : this.buckets) {
+        for (LinkedList<T> bucket : buckets) {
             while (bucket.size() != 0) {
                 outputList.add(bucket.pop());
             }