Merge branch 'master' into refactor/LowestBasePalindrome

Author: siriak

src/main/java/com/thealgorithms/dynamicprogramming/FordFulkerson.java

@@ -2,76 +2,54 @@
 
 import java.util.LinkedList;
 import java.util.Queue;
-import java.util.Vector;
 
 public final class FordFulkerson {
-    private FordFulkerson() {
-    }
-
-    static final int INF = 987654321;
-    // edges
-    static int vertexCount;
-    static int[][] capacity;
-    static int[][] flow;
+    private static final int INF = Integer.MAX_VALUE;
 
-    public static void main(String[] args) {
-        System.out.println("Vertex Count : 6");
-        vertexCount = 6;
-        capacity = new int[vertexCount][vertexCount];
-
-        capacity[0][1] = 12;
-        capacity[0][3] = 13;
-        capacity[1][2] = 10;
-        capacity[2][3] = 13;
-        capacity[2][4] = 3;
-        capacity[2][5] = 15;
-        capacity[3][2] = 7;
-        capacity[3][4] = 15;
-        capacity[4][5] = 17;
-
-        System.out.println("Max capacity in networkFlow : " + networkFlow(0, 5));
+    private FordFulkerson() {
     }
 
-    private static int networkFlow(int source, int sink) {
-        flow = new int[vertexCount][vertexCount];
+    public static int networkFlow(int vertexCount, int[][] capacity, int[][] flow, int source, int sink) {
         int totalFlow = 0;
+
         while (true) {
-            Vector<Integer> parent = new Vector<>(vertexCount);
-            for (int i = 0; i < vertexCount; i++) {
-                parent.add(-1);
-            }
-            Queue<Integer> q = new LinkedList<>();
-            parent.set(source, source);
-            q.add(source);
-            while (!q.isEmpty() && parent.get(sink) == -1) {
-                int here = q.peek();
-                q.poll();
-                for (int there = 0; there < vertexCount; ++there) {
-                    if (capacity[here][there] - flow[here][there] > 0 && parent.get(there) == -1) {
-                        q.add(there);
-                        parent.set(there, here);
+            int[] parent = new int[vertexCount];
+            boolean[] visited = new boolean[vertexCount];
+            Queue<Integer> queue = new LinkedList<>();
+
+            queue.add(source);
+            visited[source] = true;
+            parent[source] = -1;
+
+            while (!queue.isEmpty() && !visited[sink]) {
+                int current = queue.poll();
+
+                for (int next = 0; next < vertexCount; next++) {
+                    if (!visited[next] && capacity[current][next] - flow[current][next] > 0) {
+                        queue.add(next);
+                        visited[next] = true;
+                        parent[next] = current;
                     }
                 }
             }
-            if (parent.get(sink) == -1) {
-                break;
+
+            if (!visited[sink]) {
+                break; // No more augmenting paths
             }
 
-            int amount = INF;
-            String printer = "path : ";
-            StringBuilder sb = new StringBuilder();
-            for (int p = sink; p != source; p = parent.get(p)) {
-                amount = Math.min(capacity[parent.get(p)][p] - flow[parent.get(p)][p], amount);
-                sb.append(p + "-");
+            int pathFlow = INF;
+            for (int v = sink; v != source; v = parent[v]) {
+                int u = parent[v];
+                pathFlow = Math.min(pathFlow, capacity[u][v] - flow[u][v]);
             }
-            sb.append(source);
-            for (int p = sink; p != source; p = parent.get(p)) {
-                flow[parent.get(p)][p] += amount;
-                flow[p][parent.get(p)] -= amount;
+
+            for (int v = sink; v != source; v = parent[v]) {
+                int u = parent[v];
+                flow[u][v] += pathFlow;
+                flow[v][u] -= pathFlow;
             }
-            totalFlow += amount;
-            printer += sb.reverse() + " / max flow : " + totalFlow;
-            System.out.println(printer);
+
+            totalFlow += pathFlow;
         }
 
         return totalFlow;

src/main/java/com/thealgorithms/others/ReverseStackUsingRecursion.java

@@ -1,63 +1,44 @@
 package com.thealgorithms.others;
 
-/* Program to reverse a Stack using Recursion*/
 import java.util.Stack;
 
+/**
+ * Class that provides methods to reverse a stack using recursion.
+ */
 public final class ReverseStackUsingRecursion {
     private ReverseStackUsingRecursion() {
     }
 
-    // Stack
-    private static Stack<Integer> stack = new Stack<>();
-
-    // Main function
-    public static void main(String[] args) {
-        // To Create a Dummy Stack containing integers from 0-9
-        for (int i = 0; i < 10; i++) {
-            stack.push(i);
-        }
-        System.out.println("STACK");
-
-        // To print that dummy Stack
-        for (int k = 9; k >= 0; k--) {
-            System.out.println(k);
+    /**
+     * Reverses the elements of the given stack using recursion.
+     *
+     * @param stack the stack to be reversed
+     * @throws IllegalArgumentException if the stack is null
+     */
+    public static void reverse(Stack<Integer> stack) {
+        if (stack == null) {
+            throw new IllegalArgumentException("Stack cannot be null");
         }
-
-        // Reverse Function called
-        reverseUsingRecursion(stack);
-
-        System.out.println("REVERSED STACK : ");
-        // To print reversed  stack
-        while (!stack.isEmpty()) {
-            System.out.println(stack.pop());
+        if (!stack.isEmpty()) {
+            int topElement = stack.pop();
+            reverse(stack);
+            insertAtBottom(stack, topElement);
         }
     }
 
-    // Function Used to reverse Stack Using Recursion
-    private static void reverseUsingRecursion(Stack<Integer> stack) {
-        if (stack.isEmpty()) { // If stack is empty then return
-            return;
-        }
-        /* All items are stored in call stack until we reach the end*/
-
-        int temptop = stack.peek();
-        stack.pop();
-        reverseUsingRecursion(stack); // Recursion call
-        insertAtEnd(temptop); // Insert items held in call stack one by one into stack
-    }
-
-    // Function used to insert element at the end of stack
-    private static void insertAtEnd(int temptop) {
+    /**
+     * Inserts an element at the bottom of the given stack.
+     *
+     * @param stack    the stack where the element will be inserted
+     * @param element  the element to be inserted at the bottom
+     */
+    private static void insertAtBottom(Stack<Integer> stack, int element) {
         if (stack.isEmpty()) {
-            stack.push(temptop); // If stack is empty push the element
+            stack.push(element);
         } else {
-            int temp = stack.peek();
-            /* All the items are stored in call stack until we reach end*/
-            stack.pop();
-
-            insertAtEnd(temptop); // Recursive call
-
-            stack.push(temp);
+            int topElement = stack.pop();
+            insertAtBottom(stack, element);
+            stack.push(topElement);
         }
     }
 }

src/main/java/com/thealgorithms/others/TwoPointers.java

@@ -1,39 +1,33 @@
 package com.thealgorithms.others;
 
-import java.util.Arrays;
-
 /**
- * The two pointer technique is a useful tool to utilize when searching for
+ * The two-pointer technique is a useful tool to utilize when searching for
  * pairs in a sorted array.
  *
  * <p>
- * link: https://www.geeksforgeeks.org/two-pointers-technique/
+ * Link: https://www.geeksforgeeks.org/two-pointers-technique/
  */
 final class TwoPointers {
     private TwoPointers() {
     }
 
     /**
-     * Given a sorted array arr (sorted in ascending order). Find if there
-     * exists any pair of elements such that their sum is equal to key.
+     * Given a sorted array arr (sorted in ascending order), find if there exists
+     * any pair of elements such that their sum is equal to the key.
      *
-     * @param arr the array contains elements
+     * @param arr the array containing elements (must be sorted in ascending order)
      * @param key the number to search
-     * @return {@code true} if there exists a pair of elements, {@code false}
-     * otherwise.
+     * @return {@code true} if there exists a pair of elements, {@code false} otherwise.
      */
     public static boolean isPairedSum(int[] arr, int key) {
-        /* array sorting is necessary for this algorithm to function correctly */
-        Arrays.sort(arr);
-        int i = 0;
-        /* index of first element */
-        int j = arr.length - 1;
-        /* index of last element */
+        int i = 0; // index of the first element
+        int j = arr.length - 1; // index of the last element
 
         while (i < j) {
-            if (arr[i] + arr[j] == key) {
+            int sum = arr[i] + arr[j];
+            if (sum == key) {
                 return true;
-            } else if (arr[i] + arr[j] < key) {
+            } else if (sum < key) {
                 i++;
             } else {
                 j--;

src/test/java/com/thealgorithms/dynamicprogramming/FordFulkersonTest.java

@@ -0,0 +1,94 @@
+package com.thealgorithms.dynamicprogramming;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import org.junit.jupiter.api.Test;
+
+public class FordFulkersonTest {
+    @Test
+    public void testMaxFlow() {
+        int vertexCount = 6;
+        int[][] capacity = new int[vertexCount][vertexCount];
+        int[][] flow = new int[vertexCount][vertexCount];
+
+        // Setting up the capacity graph
+        capacity[0][1] = 12;
+        capacity[0][3] = 13;
+        capacity[1][2] = 10;
+        capacity[2][3] = 13;
+        capacity[2][4] = 3;
+        capacity[2][5] = 15;
+        capacity[3][2] = 7;
+        capacity[3][4] = 15;
+        capacity[4][5] = 17;
+
+        int maxFlow = FordFulkerson.networkFlow(vertexCount, capacity, flow, 0, 5);
+        assertEquals(23, maxFlow);
+    }
+
+    @Test
+    public void testNoFlow() {
+        int vertexCount = 6;
+        int[][] capacity = new int[vertexCount][vertexCount];
+        int[][] flow = new int[vertexCount][vertexCount];
+
+        // No connections between source and sink
+        capacity[0][1] = 10;
+        capacity[2][3] = 10;
+
+        int maxFlow = FordFulkerson.networkFlow(vertexCount, capacity, flow, 1, 4);
+        assertEquals(0, maxFlow);
+    }
+
+    @Test
+    public void testSinglePath() {
+        int vertexCount = 6;
+        int[][] capacity = new int[vertexCount][vertexCount];
+        int[][] flow = new int[vertexCount][vertexCount];
+
+        // Setting up a single path from source to sink
+        capacity[0][1] = 5;
+        capacity[1][2] = 5;
+        capacity[2][3] = 5;
+        capacity[3][4] = 5;
+        capacity[4][5] = 5;
+
+        int maxFlow = FordFulkerson.networkFlow(vertexCount, capacity, flow, 0, 5);
+        assertEquals(5, maxFlow);
+    }
+
+    @Test
+    public void testParallelPaths() {
+        int vertexCount = 4;
+        int[][] capacity = new int[vertexCount][vertexCount];
+        int[][] flow = new int[vertexCount][vertexCount];
+
+        // Setting up parallel paths from source to sink
+        capacity[0][1] = 10;
+        capacity[0][2] = 10;
+        capacity[1][3] = 10;
+        capacity[2][3] = 10;
+
+        int maxFlow = FordFulkerson.networkFlow(vertexCount, capacity, flow, 0, 3);
+        assertEquals(20, maxFlow);
+    }
+
+    @Test
+    public void testComplexNetwork() {
+        int vertexCount = 5;
+        int[][] capacity = new int[vertexCount][vertexCount];
+        int[][] flow = new int[vertexCount][vertexCount];
+
+        // Complex network
+        capacity[0][1] = 10;
+        capacity[0][2] = 10;
+        capacity[1][3] = 4;
+        capacity[1][4] = 8;
+        capacity[2][4] = 9;
+        capacity[3][2] = 6;
+        capacity[3][4] = 10;
+
+        int maxFlow = FordFulkerson.networkFlow(vertexCount, capacity, flow, 0, 4);
+        assertEquals(19, maxFlow);
+    }
+}