Merge branch 'master' into solovay-strassen

Author: alxkm

DIRECTORY.md

@@ -1010,18 +1010,22 @@
             * [JumpSearchTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/searches/JumpSearchTest.java)
             * [KMPSearchTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/searches/KMPSearchTest.java)
             * [LinearSearchTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/searches/LinearSearchTest.java)
+            * [LinearSearchThreadTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/searches/LinearSearchThreadTest.java)
             * [MonteCarloTreeSearchTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/searches/MonteCarloTreeSearchTest.java)
             * [OrderAgnosticBinarySearchTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/searches/OrderAgnosticBinarySearchTest.java)
             * [PerfectBinarySearchTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/searches/PerfectBinarySearchTest.java)
             * [QuickSelectTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/searches/QuickSelectTest.java)
             * [RabinKarpAlgorithmTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/searches/RabinKarpAlgorithmTest.java)
             * [RecursiveBinarySearchTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/searches/RecursiveBinarySearchTest.java)
             * [RowColumnWiseSorted2dArrayBinarySearchTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/searches/RowColumnWiseSorted2dArrayBinarySearchTest.java)
+            * [SaddlebackSearchTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/searches/SaddlebackSearchTest.java)
             * [SearchInARowAndColWiseSortedMatrixTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/searches/SearchInARowAndColWiseSortedMatrixTest.java)
             * [SortOrderAgnosticBinarySearchTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/searches/SortOrderAgnosticBinarySearchTest.java)
             * [SquareRootBinarySearchTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/searches/SquareRootBinarySearchTest.java)
+            * [TernarySearchTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/searches/TernarySearchTest.java)
             * [TestSearchInARowAndColWiseSortedMatrix](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/searches/TestSearchInARowAndColWiseSortedMatrix.java)
             * [UnionFindTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/searches/UnionFindTest.java)
+            * [UpperBoundTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/searches/UpperBoundTest.java)
           * sorts
             * [BeadSortTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/sorts/BeadSortTest.java)
             * [BinaryInsertionSortTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/sorts/BinaryInsertionSortTest.java)

src/main/java/com/thealgorithms/searches/LinearSearchThread.java

@@ -1,59 +1,57 @@
 package com.thealgorithms.searches;
 
-import java.util.Scanner;
-
+/**
+ * LinearSearchThread is a multithreaded implementation of the linear search algorithm.
+ * It creates multiple threads to search for a specific number in an array.
+ *
+ * <p>
+ * The class generates an array of random integers, prompts the user to enter a number to search for,
+ * and divides the array into four segments, each handled by a separate thread.
+ * The threads run concurrently and search for the specified number within their designated segments.
+ * Finally, it consolidates the results to determine if the number was found.
+ * </p>
+ *
+ * <p>
+ * Example usage:
+ * 1. The program will output the generated array.
+ * 2. The user will be prompted to input a number to search for.
+ * 3. The program will display whether the number was found in the array.
+ * </p>
+ */
 public final class LinearSearchThread {
     private LinearSearchThread() {
     }
-
-    public static void main(String[] args) {
-        int[] list = new int[200];
-        for (int j = 0; j < list.length; j++) {
-            list[j] = (int) (Math.random() * 100);
-        }
-        for (int y : list) {
-            System.out.print(y + " ");
-        }
-        System.out.println();
-        System.out.print("Enter number to search for: ");
-        Scanner in = new Scanner(System.in);
-        int x = in.nextInt();
-        Searcher t = new Searcher(list, 0, 50, x);
-        Searcher t1 = new Searcher(list, 50, 100, x);
-        Searcher t2 = new Searcher(list, 100, 150, x);
-        Searcher t3 = new Searcher(list, 150, 200, x);
-        t.start();
-        t1.start();
-        t2.start();
-        t3.start();
-        try {
-            t.join();
-            t1.join();
-            t2.join();
-            t3.join();
-        } catch (InterruptedException e) {
-        }
-        boolean found = t.getResult() || t1.getResult() || t2.getResult() || t3.getResult();
-        System.out.println("Found = " + found);
-        in.close();
-    }
 }
 
+/**
+ * The Searcher class extends Thread and is responsible for searching for a specific
+ * number in a segment of an array.
+ */
 class Searcher extends Thread {
+    private final int[] arr; // The array to search in
+    private final int left; // Starting index of the segment
+    private final int right; // Ending index of the segment
+    private final int x; // The number to search for
+    private boolean found; // Result flag
 
-    private final int[] arr;
-    private final int left;
-    private final int right;
-    private final int x;
-    private boolean found;
-
+    /**
+     * Constructor to initialize the Searcher.
+     *
+     * @param arr The array to search in
+     * @param left The starting index of the segment
+     * @param right The ending index of the segment
+     * @param x The number to search for
+     */
     Searcher(int[] arr, int left, int right, int x) {
         this.arr = arr;
         this.left = left;
         this.right = right;
         this.x = x;
     }
 
+    /**
+     * The run method for the thread, performing the linear search in its segment.
+     */
     @Override
     public void run() {
         int k = left;
@@ -65,6 +63,11 @@ public void run() {
         }
     }
 
+    /**
+     * Returns whether the number was found in the segment.
+     *
+     * @return true if the number was found, false otherwise
+     */
     boolean getResult() {
         return found;
     }

src/main/java/com/thealgorithms/searches/SaddlebackSearch.java

@@ -1,7 +1,5 @@
 package com.thealgorithms.searches;
 
-import java.util.Scanner;
-
 /**
  * Program to perform Saddleback Search Given a sorted 2D array(elements are
  * sorted across every row and column, assuming ascending order) of size n*m we
@@ -27,10 +25,15 @@ private SaddlebackSearch() {
      * @param row the current row.
      * @param col the current column.
      * @param key the element that we want to search for.
+     * @throws IllegalArgumentException if the array is empty.
      * @return The index(row and column) of the element if found. Else returns
      * -1 -1.
      */
-    private static int[] find(int[][] arr, int row, int col, int key) {
+    static int[] find(int[][] arr, int row, int col, int key) {
+        if (arr.length == 0) {
+            throw new IllegalArgumentException("Array is empty");
+        }
+
         // array to store the answer row and column
         int[] ans = {-1, -1};
         if (row < 0 || col >= arr[row].length) {
@@ -47,30 +50,4 @@ else if (arr[row][col] > key) {
         // else we move right
         return find(arr, row, col + 1, key);
     }
-
-    /**
-     * Main method
-     *
-     * @param args Command line arguments
-     */
-    public static void main(String[] args) {
-        // TODO Auto-generated method stub
-        Scanner sc = new Scanner(System.in);
-        int[][] arr;
-        int i;
-        int j;
-        int rows = sc.nextInt();
-        int col = sc.nextInt();
-        arr = new int[rows][col];
-        for (i = 0; i < rows; i++) {
-            for (j = 0; j < col; j++) {
-                arr[i][j] = sc.nextInt();
-            }
-        }
-        int ele = sc.nextInt();
-        // we start from bottom left corner
-        int[] ans = find(arr, rows - 1, 0, ele);
-        System.out.println(ans[0] + " " + ans[1]);
-        sc.close();
-    }
 }

src/main/java/com/thealgorithms/searches/TernarySearch.java

@@ -1,9 +1,6 @@
 package com.thealgorithms.searches;
 
 import com.thealgorithms.devutils.searches.SearchAlgorithm;
-import java.util.Arrays;
-import java.util.Random;
-import java.util.stream.Stream;
 
 /**
  * A ternary search algorithm is a technique in computer science for finding the
@@ -60,23 +57,4 @@ private <T extends Comparable<T>> int ternarySearch(T[] arr, T key, int start, i
             return ternarySearch(arr, key, mid1, mid2);
         }
     }
-
-    public static void main(String[] args) {
-        // just generate data
-        Random r = new Random();
-        int size = 100;
-        int maxElement = 100000;
-        Integer[] integers = Stream.generate(() -> r.nextInt(maxElement)).limit(size).sorted().toArray(Integer[] ::new);
-
-        // the element that should be found
-        Integer shouldBeFound = integers[r.nextInt(size - 1)];
-
-        TernarySearch search = new TernarySearch();
-        int atIndex = search.find(integers, shouldBeFound);
-
-        System.out.printf("Should be found: %d. Found %d at index %d. An array length %d%n", shouldBeFound, integers[atIndex], atIndex, size);
-
-        int toCheck = Arrays.binarySearch(integers, shouldBeFound);
-        System.out.printf("Found by system method at an index: %d. Is equal: %b%n", toCheck, toCheck == atIndex);
-    }
 }

src/main/java/com/thealgorithms/searches/UpperBound.java

@@ -1,9 +1,6 @@
 package com.thealgorithms.searches;
 
 import com.thealgorithms.devutils.searches.SearchAlgorithm;
-import java.util.Random;
-import java.util.concurrent.ThreadLocalRandom;
-import java.util.stream.IntStream;
 
 /**
  * The UpperBound method is used to return an index pointing to the first
@@ -25,28 +22,6 @@
  */
 class UpperBound implements SearchAlgorithm {
 
-    // Driver Program
-    public static void main(String[] args) {
-        // Just generate data
-        Random r = ThreadLocalRandom.current();
-
-        int size = 100;
-        int maxElement = 100000;
-
-        Integer[] integers = IntStream.generate(() -> r.nextInt(maxElement)).limit(size).sorted().boxed().toArray(Integer[] ::new);
-
-        // The element for which the upper bound is to be found
-        int val = integers[r.nextInt(size - 1)] + 1;
-
-        UpperBound search = new UpperBound();
-        int atIndex = search.find(integers, val);
-
-        System.out.printf("Val: %d. Upper Bound Found %d at index %d. An array length %d%n", val, integers[atIndex], atIndex, size);
-
-        boolean toCheck = integers[atIndex] > val || integers[size - 1] < val;
-        System.out.printf("Upper Bound found at an index: %d. Is greater or max element: %b%n", atIndex, toCheck);
-    }
-
     /**
      * @param array is an array where the UpperBound value is to be found
      * @param key is an element for which the UpperBound is to be found

src/test/java/com/thealgorithms/searches/LinearSearchThreadTest.java

@@ -0,0 +1,74 @@
+package com.thealgorithms.searches;
+
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import org.junit.jupiter.api.Test;
+
+class LinearSearchThreadTest {
+
+    /**
+     * Test for finding an element that is present in the array.
+     */
+    @Test
+    void testSearcherFound() throws InterruptedException {
+        int[] array = {0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10};
+        Searcher searcher = new Searcher(array, 0, array.length, 5);
+        searcher.start();
+        searcher.join();
+        assertTrue(searcher.getResult(), "The element 5 should be found in the array.");
+    }
+
+    /**
+     * Test for finding an element that is not present in the array.
+     */
+    @Test
+    void testSearcherNotFound() throws InterruptedException {
+        int[] array = {0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10};
+        Searcher searcher = new Searcher(array, 0, array.length, 11);
+        searcher.start();
+        searcher.join();
+        assertFalse(searcher.getResult(), "The element 11 should not be found in the array.");
+    }
+
+    /**
+     * Test for searching a segment of the array.
+     */
+    @Test
+    void testSearcherSegmentFound() throws InterruptedException {
+        int[] array = {0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10};
+        Searcher searcher = new Searcher(array, 0, 5, 3);
+        searcher.start();
+        searcher.join();
+        assertTrue(searcher.getResult(), "The element 3 should be found in the segment.");
+    }
+
+    /**
+     * Test for searching an empty array segment.
+     */
+    @Test
+    void testSearcherEmptySegment() throws InterruptedException {
+        int[] array = {};
+        Searcher searcher = new Searcher(array, 0, 0, 1); // Empty array
+        searcher.start();
+        searcher.join();
+        assertFalse(searcher.getResult(), "The element should not be found in an empty segment.");
+    }
+
+    /**
+     * Test for searching with random numbers.
+     */
+    @Test
+    void testSearcherRandomNumbers() throws InterruptedException {
+        int size = 200;
+        int[] array = new int[size];
+        for (int i = 0; i < size; i++) {
+            array[i] = (int) (Math.random() * 100);
+        }
+        int target = array[(int) (Math.random() * size)]; // Randomly select a target that is present
+        Searcher searcher = new Searcher(array, 0, size, target);
+        searcher.start();
+        searcher.join();
+        assertTrue(searcher.getResult(), "The randomly selected target should be found in the array.");
+    }
+}