Author: clintaire

.github/CODEOWNERS

@@ -1 +1 @@
-* @DenizAltunkapan @yanglbme @vil02 @BamaCharanChhandogi @alxkm @siriak
+* @DenizAltunkapan @yanglbme @vil02 @alxkm

.github/workflows/update_directory.yml

@@ -20,7 +20,7 @@
             <dependency>
                 <groupId>org.junit</groupId>
                 <artifactId>junit-bom</artifactId>
-                <version>5.13.2</version>
+                <version>5.13.3</version>
                 <type>pom</type>
                 <scope>import</scope>
             </dependency>
@@ -48,7 +48,7 @@
         <dependency>
             <groupId>org.apache.commons</groupId>
             <artifactId>commons-lang3</artifactId>
-            <version>3.17.0</version>
+            <version>3.18.0</version>
         </dependency>
         <dependency>
             <groupId>org.apache.commons</groupId>
@@ -113,7 +113,7 @@
                     <dependency>
                     <groupId>com.puppycrawl.tools</groupId>
                     <artifactId>checkstyle</artifactId>
-                    <version>10.26.0</version>
+                    <version>10.26.1</version>
                     </dependency>
                 </dependencies>
             </plugin>

DIRECTORY.md

@@ -1,12 +1,27 @@
 package com.thealgorithms.bitmanipulation;
 
+/**
+ * Utility class for performing bit-swapping operations on integers.
+ * This class cannot be instantiated.
+ */
 public final class BitSwap {
     private BitSwap() {
     }
-    /*
-     * @brief Swaps the bits at the position posA and posB from data
+
+    /**
+     * Swaps two bits at specified positions in an integer.
+     *
+     * @param data The input integer whose bits need to be swapped
+     * @param posA The position of the first bit (0-based, from least significant)
+     * @param posB The position of the second bit (0-based, from least significant)
+     * @return The modified value with swapped bits
+     * @throws IllegalArgumentException if either position is negative or ≥ 32
      */
     public static int bitSwap(int data, final int posA, final int posB) {
+        if (posA < 0 || posA >= Integer.SIZE || posB < 0 || posB >= Integer.SIZE) {
+            throw new IllegalArgumentException("Bit positions must be between 0 and 31");
+        }
+
         if (SingleBitOperations.getBit(data, posA) != SingleBitOperations.getBit(data, posB)) {
             data ^= (1 << posA) ^ (1 << posB);
         }

pom.xml

@@ -1,36 +1,43 @@
 package com.thealgorithms.maths;
 
 /**
- * https://en.wikipedia.org/wiki/Pythagorean_triple
+ * Utility class to check if three integers form a Pythagorean triple.
+ * A Pythagorean triple consists of three positive integers a, b, and c,
+ * such that a² + b² = c².
+ *
+ * Common examples:
+ * - (3, 4, 5)
+ * - (5, 12, 13)
+ *
+ * Reference: https://en.wikipedia.org/wiki/Pythagorean_triple
  */
 public final class PythagoreanTriple {
-    private PythagoreanTriple() {
-    }
 
-    public static void main(String[] args) {
-        assert isPythagTriple(3, 4, 5);
-        assert isPythagTriple(5, 12, 13);
-        assert isPythagTriple(6, 8, 10);
-        assert !isPythagTriple(10, 20, 30);
-        assert !isPythagTriple(6, 8, 100);
-        assert !isPythagTriple(-1, -1, 1);
+    private PythagoreanTriple() {
     }
 
     /**
-     * Check if a,b,c are a Pythagorean Triple
+     * Checks whether three integers form a Pythagorean triple.
+     * The order of parameters does not matter.
      *
-     * @param a x/y component length of a right triangle
-     * @param b y/x component length of a right triangle
-     * @param c hypotenuse length of a right triangle
-     * @return boolean <tt>true</tt> if a, b, c satisfy the Pythagorean theorem,
-     * otherwise
-     * <tt>false</tt>
+     * @param a one side length
+     * @param b another side length
+     * @param c another side length
+     * @return {@code true} if (a, b, c) can form a Pythagorean triple, otherwise {@code false}
      */
     public static boolean isPythagTriple(int a, int b, int c) {
         if (a <= 0 || b <= 0 || c <= 0) {
             return false;
-        } else {
-            return (a * a) + (b * b) == (c * c);
         }
+
+        // Sort the sides so the largest is treated as hypotenuse
+        int[] sides = {a, b, c};
+        java.util.Arrays.sort(sides);
+
+        int x = sides[0];
+        int y = sides[1];
+        int hypotenuse = sides[2];
+
+        return x * x + y * y == hypotenuse * hypotenuse;
     }
 }

src/main/java/com/thealgorithms/bitmanipulation/BitSwap.java

@@ -7,35 +7,34 @@
 import java.util.function.Function;
 import java.util.stream.Collectors;
 
-/*
-* MapReduce is a programming model for processing and generating large data sets with a parallel,
-distributed algorithm on a cluster.
-* It has two main steps: the Map step, where the data is divided into smaller chunks and processed in parallel,
-and the Reduce step, where the results from the Map step are combined to produce the final output.
-* Wikipedia link : https://en.wikipedia.org/wiki/MapReduce
-*/
-
+/**
+ * MapReduce is a programming model for processing and generating large data sets
+ * using a parallel, distributed algorithm on a cluster.
+ * It consists of two main phases:
+ * - Map: the input data is split into smaller chunks and processed in parallel.
+ * - Reduce: the results from the Map phase are aggregated to produce the final output.
+ *
+ * See also: https://en.wikipedia.org/wiki/MapReduce
+ */
 public final class MapReduce {
+
     private MapReduce() {
     }
-    /*
-     *Counting all the words frequency within a sentence.
-     */
-    public static String mapreduce(String sentence) {
-        List<String> wordList = Arrays.stream(sentence.split(" ")).toList();
 
-        // Map step
-        Map<String, Long> wordCounts = wordList.stream().collect(Collectors.groupingBy(Function.identity(), LinkedHashMap::new, Collectors.counting()));
-
-        // Reduce step
-        StringBuilder result = new StringBuilder();
-        wordCounts.forEach((word, count) -> result.append(word).append(": ").append(count).append(","));
+    /**
+     * Counts the frequency of each word in a given sentence using a simple MapReduce-style approach.
+     *
+     * @param sentence the input sentence
+     * @return a string representing word frequencies in the format "word: count,word: count,..."
+     */
+    public static String countWordFrequencies(String sentence) {
+        // Map phase: split the sentence into words
+        List<String> words = Arrays.asList(sentence.trim().split("\\s+"));
 
-        // Removing the last ',' if it exists
-        if (!result.isEmpty()) {
-            result.setLength(result.length() - 1);
-        }
+        // Group and count occurrences of each word, maintain insertion order
+        Map<String, Long> wordCounts = words.stream().collect(Collectors.groupingBy(Function.identity(), LinkedHashMap::new, Collectors.counting()));
 
-        return result.toString();
+        // Reduce phase: format the result
+        return wordCounts.entrySet().stream().map(entry -> entry.getKey() + ": " + entry.getValue()).collect(Collectors.joining(","));
     }
 }

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

@@ -4,50 +4,74 @@
 import java.util.PriorityQueue;
 
 /**
- * @author shrutisheoran
+ * A generic abstract class to compute the median of a dynamically growing stream of numbers.
+ *
+ * @param <T> the number type, must extend Number and be Comparable
+ *
+ * Usage:
+ * Extend this class and implement {@code calculateAverage(T a, T b)} to define how averaging is done.
  */
 public abstract class MedianOfRunningArray<T extends Number & Comparable<T>> {
 
-    private PriorityQueue<T> maxHeap;
-    private PriorityQueue<T> minHeap;
+    private final PriorityQueue<T> maxHeap; // Lower half (max-heap)
+    private final PriorityQueue<T> minHeap; // Upper half (min-heap)
 
-    // Constructor
     public MedianOfRunningArray() {
-        this.maxHeap = new PriorityQueue<>(Collections.reverseOrder()); // Max Heap
-        this.minHeap = new PriorityQueue<>(); // Min Heap
+        this.maxHeap = new PriorityQueue<>(Collections.reverseOrder());
+        this.minHeap = new PriorityQueue<>();
     }
 
-    /*
-      Inserting lower half of array to max Heap
-      and upper half to min heap
+    /**
+     * Inserts a new number into the data structure.
+     *
+     * @param element the number to insert
      */
-    public void insert(final T e) {
-        if (!minHeap.isEmpty() && e.compareTo(minHeap.peek()) < 0) {
-            maxHeap.offer(e);
-            if (maxHeap.size() > minHeap.size() + 1) {
-                minHeap.offer(maxHeap.poll());
-            }
+    public final void insert(final T element) {
+        if (!minHeap.isEmpty() && element.compareTo(minHeap.peek()) < 0) {
+            maxHeap.offer(element);
+            balanceHeapsIfNeeded();
         } else {
-            minHeap.offer(e);
-            if (minHeap.size() > maxHeap.size() + 1) {
-                maxHeap.offer(minHeap.poll());
-            }
+            minHeap.offer(element);
+            balanceHeapsIfNeeded();
         }
     }
 
-    /*
-      Returns median at any given point
+    /**
+     * Returns the median of the current elements.
+     *
+     * @return the median value
+     * @throws IllegalArgumentException if no elements have been inserted
      */
-    public T median() {
+    public final T getMedian() {
         if (maxHeap.isEmpty() && minHeap.isEmpty()) {
-            throw new IllegalArgumentException("Enter at least 1 element, Median of empty list is not defined!");
-        } else if (maxHeap.size() == minHeap.size()) {
-            T maxHeapTop = maxHeap.peek();
-            T minHeapTop = minHeap.peek();
-            return calculateAverage(maxHeapTop, minHeapTop);
+            throw new IllegalArgumentException("Median is undefined for an empty data set.");
         }
-        return maxHeap.size() > minHeap.size() ? maxHeap.peek() : minHeap.peek();
+
+        if (maxHeap.size() == minHeap.size()) {
+            return calculateAverage(maxHeap.peek(), minHeap.peek());
+        }
+
+        return (maxHeap.size() > minHeap.size()) ? maxHeap.peek() : minHeap.peek();
     }
 
-    public abstract T calculateAverage(T a, T b);
+    /**
+     * Calculates the average between two values.
+     * Concrete subclasses must define how averaging works (e.g., for Integer, Double, etc.).
+     *
+     * @param a first number
+     * @param b second number
+     * @return the average of a and b
+     */
+    protected abstract T calculateAverage(T a, T b);
+
+    /**
+     * Balances the two heaps so that their sizes differ by at most 1.
+     */
+    private void balanceHeapsIfNeeded() {
+        if (maxHeap.size() > minHeap.size() + 1) {
+            minHeap.offer(maxHeap.poll());
+        } else if (minHeap.size() > maxHeap.size() + 1) {
+            maxHeap.offer(minHeap.poll());
+        }
+    }
 }