Merge branch 'master' into add-happy-number

Author: DenizAltunkapan

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

@@ -0,0 +1,63 @@
+package com.thealgorithms.maths;
+
+import com.thealgorithms.maths.Prime.PrimeCheck;
+
+/**
+ * A utility class to check whether a number is a Germain prime or a Safe prime.
+ *
+ * <p>This class provides methods to:
+ * <ul>
+ *   <li>Check if a number is a Germain prime</li>
+ *   <li>Check if a number is a Safe prime</li>
+ * </ul>
+ *
+ * <p>Definitions:
+ * <ul>
+ *   <li>A Germain prime is a prime number p such that 2p + 1 is also prime.</li>
+ *   <li>A Safe prime is a prime number p such that (p - 1) / 2 is also prime.</li>
+ * </ul>
+ *
+ * <p>This class is final and cannot be instantiated.
+ *
+ * @see <a href="https://en.wikipedia.org/wiki/Safe_and_Sophie_Germain_primes">Wikipedia: Safe and Sophie Germain primes</a>
+ */
+public final class GermainPrimeAndSafePrime {
+
+    // Private constructor to prevent instantiation
+    private GermainPrimeAndSafePrime() {
+    }
+
+    /**
+     * Checks if a number is a Germain prime.
+     *
+     * <p>A Germain prime is a prime number p such that 2p + 1 is also prime.
+     *
+     * @param number the number to check; must be a positive integer
+     * @return {@code true} if the number is a Germain prime, {@code false} otherwise
+     * @throws IllegalArgumentException if the input number is less than 1
+     */
+    public static boolean isGermainPrime(int number) {
+        if (number < 1) {
+            throw new IllegalArgumentException("Input value must be a positive integer. Input value: " + number);
+        }
+        // A number is a Germain prime if it is prime and 2 * number + 1 is also prime
+        return PrimeCheck.isPrime(number) && PrimeCheck.isPrime(2 * number + 1);
+    }
+
+    /**
+     * Checks if a number is a Safe prime.
+     *
+     * <p>A Safe prime is a prime number p such that (p - 1) / 2 is also prime.
+     *
+     * @param number the number to check; must be a positive integer
+     * @return {@code true} if the number is a Safe prime, {@code false} otherwise
+     * @throws IllegalArgumentException if the input number is less than 1
+     */
+    public static boolean isSafePrime(int number) {
+        if (number < 1) {
+            throw new IllegalArgumentException("Input value must be a positive integer. Input value: " + number);
+        }
+        // A number is a Safe prime if it is prime, (number - 1) is even, and (number - 1) / 2 is prime
+        return ((number - 1) % 2 == 0) && PrimeCheck.isPrime(number) && PrimeCheck.isPrime((number - 1) / 2);
+    }
+}

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

@@ -0,0 +1,102 @@
+package com.thealgorithms.others;
+
+import java.util.LinkedList;
+import java.util.Queue;
+
+/**
+ * Implementation of the Flood Fill algorithm using an iterative BFS (Breadth-First Search) approach.
+ *
+ * <p>The Flood Fill algorithm is used to fill connected areas in an image with a new color, starting from a specified point.
+ * This implementation uses an iterative BFS approach with a queue
+ * instead of recursion to avoid stack overflow issues with large images.</p>
+ *
+ * <p><b>Implementation Features:</b></p>
+ * <ul>
+ *   <li>Supports 8-connected filling (horizontal, vertical, and diagonal directions)</li>
+ *   <li>Uses BFS traversal through {@link java.util.Queue}</li>
+ *   <li>Includes nested {@code Point} class to represent pixel coordinates</li>
+ *   <li>Iterative approach avoids stack overflow for large images</li>
+ * </ul>
+ *
+ * <p><b>Time Complexity:</b> O(M × N) where M and N are the dimensions of the image</p>
+ * <p><b>Space Complexity:</b> O(M × N) in the worst case the queue stores every pixel</p>
+ *
+ * @see <a href="https://www.geeksforgeeks.org/dsa/flood-fill-algorithm">Flood Fill Algorithm - GeeksforGeeks</a>
+ * @see <a href="https://en.wikipedia.org/wiki/Flood_fill">Flood Fill Algorithm - Wikipedia</a>
+ */
+public final class IterativeFloodFill {
+    private IterativeFloodFill() {
+    }
+
+    /**
+     * Iteratively fill the 2D image with new color
+     *
+     * @param image    The image to be filled
+     * @param x        The x co-ordinate at which color is to be filled
+     * @param y        The y co-ordinate at which color is to be filled
+     * @param newColor The new color which to be filled in the image
+     * @param oldColor The old color which is to be replaced in the image
+     * @see <a href=https://www.geeksforgeeks.org/dsa/flood-fill-algorithm>FloodFill BFS<a/>
+     */
+    public static void floodFill(final int[][] image, final int x, final int y, final int newColor, final int oldColor) {
+        if (image.length == 0 || image[0].length == 0 || newColor == oldColor || shouldSkipPixel(image, x, y, oldColor)) {
+            return;
+        }
+
+        Queue<Point> queue = new LinkedList<>();
+        queue.add(new Point(x, y));
+
+        int[] dx = {0, 0, -1, 1, 1, -1, 1, -1};
+        int[] dy = {-1, 1, 0, 0, -1, 1, 1, -1};
+
+        while (!queue.isEmpty()) {
+            Point currPoint = queue.poll();
+
+            if (shouldSkipPixel(image, currPoint.x, currPoint.y, oldColor)) {
+                continue;
+            }
+
+            image[currPoint.x][currPoint.y] = newColor;
+
+            for (int i = 0; i < 8; i++) {
+                int curX = currPoint.x + dx[i];
+                int curY = currPoint.y + dy[i];
+
+                if (!shouldSkipPixel(image, curX, curY, oldColor)) {
+                    queue.add(new Point(curX, curY));
+                }
+            }
+        }
+    }
+
+    /**
+     * Represents a point in 2D space with integer coordinates.
+     */
+    private static class Point {
+        final int x;
+        final int y;
+
+        Point(final int x, final int y) {
+            this.x = x;
+            this.y = y;
+        }
+    }
+
+    /**
+     * Checks if a pixel should be skipped during flood fill operation.
+     *
+     * @param image    The image to get boundaries
+     * @param x        The x co-ordinate of pixel to check
+     * @param y        The y co-ordinate of pixel to check
+     * @param oldColor The old color which is to be replaced in the image
+     * @return {@code true} if pixel should be skipped, else {@code false}
+     */
+    private static boolean shouldSkipPixel(final int[][] image, final int x, final int y, final int oldColor) {
+
+        if (x < 0 || x >= image.length || y < 0 || y >= image[0].length || image[x][y] != oldColor) {
+            return true;
+        }
+
+        return false;
+    }
+}

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

@@ -0,0 +1,49 @@
+package com.thealgorithms.maths;
+
+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.DisplayName;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
+
+class GermainPrimeAndSafePrimeTest {
+
+    static Stream<Arguments> provideNumbersForGermainPrimes() {
+        return Stream.of(Arguments.of(2, Boolean.TRUE), Arguments.of(3, Boolean.TRUE), Arguments.of(5, Boolean.TRUE), Arguments.of(11, Boolean.TRUE), Arguments.of(23, Boolean.TRUE), Arguments.of(293, Boolean.TRUE), Arguments.of(4, Boolean.FALSE), Arguments.of(7, Boolean.FALSE),
+            Arguments.of(9, Boolean.FALSE), Arguments.of(1, Boolean.FALSE));
+    }
+
+    static Stream<Arguments> provideNumbersForSafePrimes() {
+        return Stream.of(Arguments.of(5, Boolean.TRUE), Arguments.of(7, Boolean.TRUE), Arguments.of(11, Boolean.TRUE), Arguments.of(23, Boolean.TRUE), Arguments.of(1283, Boolean.TRUE), Arguments.of(4, Boolean.FALSE), Arguments.of(13, Boolean.FALSE), Arguments.of(9, Boolean.FALSE),
+            Arguments.of(1, Boolean.FALSE));
+    }
+
+    static Stream<Integer> provideNegativeNumbers() {
+        return Stream.of(-10, -1, 0);
+    }
+
+    @ParameterizedTest
+    @MethodSource("provideNumbersForGermainPrimes")
+    @DisplayName("Check whether a number is a Germain prime")
+    void testValidGermainPrimes(int number, boolean expected) {
+        assertEquals(expected, GermainPrimeAndSafePrime.isGermainPrime(number));
+    }
+
+    @ParameterizedTest
+    @MethodSource("provideNumbersForSafePrimes")
+    @DisplayName("Check whether a number is a Safe prime")
+    void testValidSafePrimes(int number, boolean expected) {
+        assertEquals(expected, GermainPrimeAndSafePrime.isSafePrime(number));
+    }
+
+    @ParameterizedTest
+    @MethodSource("provideNegativeNumbers")
+    @DisplayName("Negative numbers and zero should throw IllegalArgumentException")
+    void testNegativeNumbersThrowException(int number) {
+        assertThrows(IllegalArgumentException.class, () -> GermainPrimeAndSafePrime.isGermainPrime(number));
+        assertThrows(IllegalArgumentException.class, () -> GermainPrimeAndSafePrime.isSafePrime(number));
+    }
+}

src/test/java/com/thealgorithms/others/IterativeFloodFillTest.java

@@ -0,0 +1,163 @@
+package com.thealgorithms.others;
+
+import static org.junit.jupiter.api.Assertions.assertArrayEquals;
+import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
+
+import org.junit.jupiter.api.Test;
+
+class IterativeFloodFillTest {
+
+    @Test
+    void testForEmptyImage() {
+        int[][] image = {};
+        int[][] expected = {};
+
+        IterativeFloodFill.floodFill(image, 4, 5, 3, 2);
+        assertArrayEquals(expected, image);
+    }
+
+    @Test
+    void testForSingleElementImage() {
+        int[][] image = {{1}};
+        int[][] expected = {{3}};
+
+        IterativeFloodFill.floodFill(image, 0, 0, 3, 1);
+        assertArrayEquals(expected, image);
+    }
+
+    @Test
+    void testForEmptyRow() {
+        int[][] image = {{}};
+        int[][] expected = {{}};
+
+        IterativeFloodFill.floodFill(image, 4, 5, 3, 2);
+        assertArrayEquals(expected, image);
+    }
+
+    @Test
+    void testForImageOne() {
+        int[][] image = {
+            {0, 0, 0, 0, 0, 0, 0},
+            {0, 3, 3, 3, 3, 0, 0},
+            {0, 3, 1, 1, 5, 0, 0},
+            {0, 3, 1, 1, 5, 5, 3},
+            {0, 3, 5, 5, 1, 1, 3},
+            {0, 0, 0, 5, 1, 1, 3},
+            {0, 0, 0, 3, 3, 3, 3},
+        };
+
+        int[][] expected = {
+            {0, 0, 0, 0, 0, 0, 0},
+            {0, 3, 3, 3, 3, 0, 0},
+            {0, 3, 2, 2, 5, 0, 0},
+            {0, 3, 2, 2, 5, 5, 3},
+            {0, 3, 5, 5, 2, 2, 3},
+            {0, 0, 0, 5, 2, 2, 3},
+            {0, 0, 0, 3, 3, 3, 3},
+        };
+
+        IterativeFloodFill.floodFill(image, 2, 2, 2, 1);
+        assertArrayEquals(expected, image);
+    }
+
+    @Test
+    void testForImageTwo() {
+        int[][] image = {
+            {0, 0, 1, 1, 0, 0, 0},
+            {1, 1, 3, 3, 3, 0, 0},
+            {1, 3, 1, 1, 5, 0, 0},
+            {0, 3, 1, 1, 5, 5, 3},
+            {0, 3, 5, 5, 1, 1, 3},
+            {0, 0, 0, 5, 1, 1, 3},
+            {0, 0, 0, 1, 3, 1, 3},
+        };
+
+        int[][] expected = {
+            {0, 0, 2, 2, 0, 0, 0},
+            {2, 2, 3, 3, 3, 0, 0},
+            {2, 3, 2, 2, 5, 0, 0},
+            {0, 3, 2, 2, 5, 5, 3},
+            {0, 3, 5, 5, 2, 2, 3},
+            {0, 0, 0, 5, 2, 2, 3},
+            {0, 0, 0, 2, 3, 2, 3},
+        };
+
+        IterativeFloodFill.floodFill(image, 2, 2, 2, 1);
+        assertArrayEquals(expected, image);
+    }
+
+    @Test
+    void testForImageThree() {
+        int[][] image = {
+            {1, 1, 2, 3, 1, 1, 1},
+            {1, 0, 0, 1, 0, 0, 1},
+            {1, 1, 1, 0, 3, 1, 2},
+        };
+
+        int[][] expected = {
+            {4, 4, 2, 3, 4, 4, 4},
+            {4, 0, 0, 4, 0, 0, 4},
+            {4, 4, 4, 0, 3, 4, 2},
+        };
+
+        IterativeFloodFill.floodFill(image, 0, 1, 4, 1);
+        assertArrayEquals(expected, image);
+    }
+
+    @Test
+    void testForSameNewAndOldColor() {
+        int[][] image = {{1, 1, 2}, {1, 0, 0}, {1, 1, 1}};
+
+        int[][] expected = {{1, 1, 2}, {1, 0, 0}, {1, 1, 1}};
+
+        IterativeFloodFill.floodFill(image, 0, 1, 1, 1);
+        assertArrayEquals(expected, image);
+    }
+
+    @Test
+    void testForBigImage() {
+        int[][] image = new int[100][100];
+
+        assertDoesNotThrow(() -> IterativeFloodFill.floodFill(image, 0, 0, 1, 0));
+    }
+
+    @Test
+    void testForBelowZeroX() {
+        int[][] image = {{1, 1, 2}, {1, 0, 0}, {1, 1, 1}};
+
+        int[][] expected = {{1, 1, 2}, {1, 0, 0}, {1, 1, 1}};
+
+        IterativeFloodFill.floodFill(image, -1, 1, 1, 0);
+        assertArrayEquals(expected, image);
+    }
+
+    @Test
+    void testForBelowZeroY() {
+        int[][] image = {{1, 1, 2}, {1, 0, 0}, {1, 1, 1}};
+
+        int[][] expected = {{1, 1, 2}, {1, 0, 0}, {1, 1, 1}};
+
+        IterativeFloodFill.floodFill(image, 1, -1, 1, 0);
+        assertArrayEquals(expected, image);
+    }
+
+    @Test
+    void testForAboveBoundaryX() {
+        int[][] image = {{1, 1, 2}, {1, 0, 0}, {1, 1, 1}};
+
+        int[][] expected = {{1, 1, 2}, {1, 0, 0}, {1, 1, 1}};
+
+        IterativeFloodFill.floodFill(image, 100, 1, 1, 0);
+        assertArrayEquals(expected, image);
+    }
+
+    @Test
+    void testForAboveBoundaryY() {
+        int[][] image = {{1, 1, 2}, {1, 0, 0}, {1, 1, 1}};
+
+        int[][] expected = {{1, 1, 2}, {1, 0, 0}, {1, 1, 1}};
+
+        IterativeFloodFill.floodFill(image, 1, 100, 1, 0);
+        assertArrayEquals(expected, image);
+    }
+}