Merge branch 'master' into testing/AbsoluteValueTest

Author: alxkm

src/main/java/com/thealgorithms/datastructures/hashmap/hashing/Intersection.java

@@ -8,60 +8,66 @@
 
 /**
  * The {@code Intersection} class provides a method to compute the intersection of two integer arrays.
- * The intersection is defined as the set of common elements present in both arrays.
  * <p>
- * This class utilizes a HashMap to efficiently count occurrences of elements in the first array,
- * allowing for an efficient lookup of common elements in the second array.
+ * This intersection includes duplicate values — meaning elements are included in the result
+ * as many times as they appear in both arrays (i.e., multiset intersection).
  * </p>
  *
  * <p>
- * Example:
- * <pre>
+ * The algorithm uses a {@link java.util.HashMap} to count occurrences of elements in the first array,
+ * then iterates through the second array to collect common elements based on these counts.
+ * </p>
+ *
+ * <p>
+ * Example usage:
+ * <pre>{@code
  * int[] array1 = {1, 2, 2, 1};
  * int[] array2 = {2, 2};
- * List<Integer> result = Intersection.intersection(array1, array2); // result will contain [2, 2]
- * </pre>
+ * List<Integer> result = Intersection.intersection(array1, array2); // result: [2, 2]
+ * }</pre>
  * </p>
  *
  * <p>
- * Note: The order of the returned list may vary since it depends on the order of elements
- * in the input arrays.
+ * Note: The order of elements in the returned list depends on the order in the second input array.
  * </p>
  */
 public final class Intersection {
 
+    private Intersection() {
+        // Utility class; prevent instantiation
+    }
+
     /**
-     * Computes the intersection of two integer arrays.
+     * Computes the intersection of two integer arrays, preserving element frequency.
+     * For example, given [1,2,2,3] and [2,2,4], the result will be [2,2].
+     *
      * Steps:
-     * 1. Count the occurrences of each element in the first array using a HashMap.
-     * 2. Iterate over the second array and check if the element is present in the HashMap.
-     * If it is, add it to the result list and decrement the count in the HashMap.
-     * 3. Return the result list containing the intersection of the two arrays.
+     * 1. Count the occurrences of each element in the first array using a map.
+     * 2. Iterate over the second array and collect common elements.
      *
      * @param arr1 the first array of integers
      * @param arr2 the second array of integers
-     * @return a list containing the intersection of the two arrays, or an empty list if either array is null or empty
+     * @return a list containing the intersection of the two arrays (with duplicates),
+     *         or an empty list if either array is null or empty
      */
     public static List<Integer> intersection(int[] arr1, int[] arr2) {
         if (arr1 == null || arr2 == null || arr1.length == 0 || arr2.length == 0) {
             return Collections.emptyList();
         }
 
-        Map<Integer, Integer> cnt = new HashMap<>(16);
-        for (int v : arr1) {
-            cnt.put(v, cnt.getOrDefault(v, 0) + 1);
+        Map<Integer, Integer> countMap = new HashMap<>();
+        for (int num : arr1) {
+            countMap.put(num, countMap.getOrDefault(num, 0) + 1);
         }
 
-        List<Integer> res = new ArrayList<>();
-        for (int v : arr2) {
-            if (cnt.containsKey(v) && cnt.get(v) > 0) {
-                res.add(v);
-                cnt.put(v, cnt.get(v) - 1);
+        List<Integer> result = new ArrayList<>();
+        for (int num : arr2) {
+            if (countMap.getOrDefault(num, 0) > 0) {
+                result.add(num);
+                countMap.computeIfPresent(num, (k, v) -> v - 1);
             }
         }
-        return res;
-    }
 
-    private Intersection() {
+        return result;
     }
 }

src/main/java/com/thealgorithms/datastructures/hashmap/hashing/MajorityElement.java

@@ -1,8 +1,10 @@
 package com.thealgorithms.datastructures.hashmap.hashing;
 
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 
 /**
  * This class provides a method to find the majority element(s) in an array of integers.
@@ -18,13 +20,18 @@ private MajorityElement() {
      * Returns a list of majority element(s) from the given array of integers.
      *
      * @param nums an array of integers
-     * @return a list containing the majority element(s); returns an empty list if none exist
+     * @return a list containing the majority element(s); returns an empty list if none exist or input is null/empty
      */
     public static List<Integer> majority(int[] nums) {
-        HashMap<Integer, Integer> numToCount = new HashMap<>();
+        if (nums == null || nums.length == 0) {
+            return Collections.emptyList();
+        }
+
+        Map<Integer, Integer> numToCount = new HashMap<>();
         for (final var num : nums) {
             numToCount.merge(num, 1, Integer::sum);
         }
+
         List<Integer> majorityElements = new ArrayList<>();
         for (final var entry : numToCount.entrySet()) {
             if (entry.getValue() >= nums.length / 2) {

src/main/java/com/thealgorithms/maths/Convolution.java

@@ -23,24 +23,21 @@ public static double[] convolution(double[] a, double[] b) {
         double[] convolved = new double[a.length + b.length - 1];
 
         /*
-    The discrete convolution of two signals A and B is defined as:
-
-          A.length
-    C[i] = Σ (A[k]*B[i-k])
-          k=0
-
-    It's obvious that:  0 <= k <= A.length , 0 <= i <= A.length + B.length - 2  and  0 <= i-k <=
-    B.length - 1 From the last inequality we get that:  i - B.length + 1 <= k <= i and thus we get
-    the conditions below.
+         * Discrete convolution formula:
+         * C[i] = Σ A[k] * B[i - k]
+         * where k ranges over valid indices so that both A[k] and B[i-k] are in bounds.
          */
+
         for (int i = 0; i < convolved.length; i++) {
-            convolved[i] = 0;
-            int k = Math.max(i - b.length + 1, 0);
+            double sum = 0;
+            int kStart = Math.max(0, i - b.length + 1);
+            int kEnd = Math.min(i, a.length - 1);
 
-            while (k < i + 1 && k < a.length) {
-                convolved[i] += a[k] * b[i - k];
-                k++;
+            for (int k = kStart; k <= kEnd; k++) {
+                sum += a[k] * b[i - k];
             }
+
+            convolved[i] = sum;
         }
 
         return convolved;

src/main/java/com/thealgorithms/maths/Mode.java

@@ -3,46 +3,49 @@
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
 
-/*
- * Find the mode of an array of numbers
- *
- * The mode of an array of numbers is the most frequently occurring number in the array,
- * or the most frequently occurring numbers if there are multiple numbers with the same frequency
+/**
+ * Utility class to calculate the mode(s) of an array of integers.
+ * <p>
+ * The mode of an array is the integer value(s) that occur most frequently.
+ * If multiple values have the same highest frequency, all such values are returned.
+ * </p>
  */
 public final class Mode {
     private Mode() {
     }
 
-    /*
-     * Find the mode of an array of integers
+    /**
+     * Computes the mode(s) of the specified array of integers.
+     * <p>
+     * If the input array is empty, this method returns {@code null}.
+     * If multiple numbers share the highest frequency, all are returned in the result array.
+     * </p>
      *
-     * @param numbers array of integers
-     * @return mode of the array
+     * @param numbers an array of integers to analyze
+     * @return an array containing the mode(s) of the input array, or {@code null} if the input is empty
      */
     public static int[] mode(final int[] numbers) {
         if (numbers.length == 0) {
             return null;
         }
 
-        HashMap<Integer, Integer> count = new HashMap<>();
+        Map<Integer, Integer> count = new HashMap<>();
 
         for (int num : numbers) {
-            if (count.containsKey(num)) {
-                count.put(num, count.get(num) + 1);
-            } else {
-                count.put(num, 1);
-            }
+            count.put(num, count.getOrDefault(num, 0) + 1);
         }
 
         int max = Collections.max(count.values());
-        ArrayList<Integer> modes = new ArrayList<>();
+        List<Integer> modes = new ArrayList<>();
 
         for (final var entry : count.entrySet()) {
             if (entry.getValue() == max) {
                 modes.add(entry.getKey());
             }
         }
-        return modes.stream().mapToInt(n -> n).toArray();
+        return modes.stream().mapToInt(Integer::intValue).toArray();
     }
 }

src/test/java/com/thealgorithms/maths/AverageTest.java

@@ -1,33 +1,48 @@
 package com.thealgorithms.maths;
 
-import org.junit.jupiter.api.Assertions;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+import java.util.stream.Stream;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
 
 public class AverageTest {
 
     private static final double SMALL_VALUE = 0.00001d;
 
-    @Test
-    public void testAverageDouble12() {
-        double[] numbers = {3d, 6d, 9d, 12d, 15d, 18d, 21d};
-        Assertions.assertEquals(12d, Average.average(numbers), SMALL_VALUE);
+    @ParameterizedTest(name = "average({0}) should be approximately {1}")
+    @MethodSource("provideDoubleArrays")
+    void testAverageDouble(double[] numbers, double expected) {
+        assertEquals(expected, Average.average(numbers), SMALL_VALUE);
     }
 
-    @Test
-    public void testAverageDouble20() {
-        double[] numbers = {5d, 10d, 15d, 20d, 25d, 30d, 35d};
-        Assertions.assertEquals(20d, Average.average(numbers), SMALL_VALUE);
+    @ParameterizedTest(name = "average({0}) should be {1}")
+    @MethodSource("provideIntArrays")
+    void testAverageInt(int[] numbers, long expected) {
+        assertEquals(expected, Average.average(numbers));
     }
 
     @Test
-    public void testAverageDouble() {
-        double[] numbers = {1d, 2d, 3d, 4d, 5d, 6d, 7d, 8d};
-        Assertions.assertEquals(4.5d, Average.average(numbers), SMALL_VALUE);
+    void testAverageDoubleThrowsExceptionOnNullOrEmpty() {
+        assertThrows(IllegalArgumentException.class, () -> Average.average((double[]) null));
+        assertThrows(IllegalArgumentException.class, () -> Average.average(new double[0]));
     }
 
     @Test
-    public void testAverageInt() {
-        int[] numbers = {2, 4, 10};
-        Assertions.assertEquals(5, Average.average(numbers));
+    void testAverageIntThrowsExceptionOnNullOrEmpty() {
+        assertThrows(IllegalArgumentException.class, () -> Average.average((int[]) null));
+        assertThrows(IllegalArgumentException.class, () -> Average.average(new int[0]));
+    }
+
+    private static Stream<Arguments> provideDoubleArrays() {
+        return Stream.of(Arguments.of(new double[] {3d, 6d, 9d, 12d, 15d, 18d, 21d}, 12d), Arguments.of(new double[] {5d, 10d, 15d, 20d, 25d, 30d, 35d}, 20d), Arguments.of(new double[] {1d, 2d, 3d, 4d, 5d, 6d, 7d, 8d}, 4.5d), Arguments.of(new double[] {0d, 0d, 0d}, 0d),
+            Arguments.of(new double[] {-1d, -2d, -3d}, -2d), Arguments.of(new double[] {1e-10, 1e-10, 1e-10}, 1e-10));
+    }
+
+    private static Stream<Arguments> provideIntArrays() {
+        return Stream.of(Arguments.of(new int[] {2, 4, 10}, 5L), Arguments.of(new int[] {0, 0, 0}, 0L), Arguments.of(new int[] {-1, -2, -3}, -2L), Arguments.of(new int[] {1, 1, 1, 1, 1}, 1L));
     }
 }