Merge branch 'TheAlgorithms:master' into master

Author: Abhinavagarwa

.github/workflows/infer.yml

@@ -0,0 +1,60 @@
+---
+name: Infer
+
+'on':
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  run_infer:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up JDK
+        uses: actions/setup-java@v4
+        with:
+          java-version: 21
+          distribution: 'adopt'
+
+      - name: Set up OCaml
+        uses: ocaml/setup-ocaml@v3
+        with:
+          ocaml-compiler: 5
+
+      - name: Get current year/weak
+        run: echo "year_week=$(date +'%Y_%U')" >> $GITHUB_ENV
+
+      - name: Cache infer build
+        id: cache-infer
+        uses: actions/cache@v4
+        with:
+          path: infer
+          key: ${{ runner.os }}-infer-${{ env.year_week }}
+
+      - name: Build infer
+        if: steps.cache-infer.outputs.cache-hit != 'true'
+        run: |
+          cd ..
+          git clone https://github.com/facebook/infer.git
+          cd infer
+          ./build-infer.sh java
+          cp -r infer ../Java
+
+      - name: Add infer to PATH
+        run: |
+          echo "infer/bin" >> $GITHUB_PATH
+
+      - name: Display infer version
+        run: |
+          which infer
+          infer --version
+
+      - name: Run infer
+        run: |
+          mvn clean
+          infer --fail-on-issue  --print-logs --no-progress-bar -- mvn test
+...

.gitignore

@@ -42,3 +42,5 @@ local.properties
 gradle.properties
 .vscode
 *.log
+
+/infer-out/

.inferconfig

@@ -0,0 +1,25 @@
+{
+    "report-block-list-path-regex": [
+        "src/main/java/com/thealgorithms/ciphers/a5/CompositeLFSR.java",
+        "src/main/java/com/thealgorithms/datastructures/crdt/GCounter.java",
+        "src/main/java/com/thealgorithms/datastructures/crdt/PNCounter.java",
+        "src/main/java/com/thealgorithms/datastructures/graphs/KahnsAlgorithm.java",
+        "src/main/java/com/thealgorithms/datastructures/heaps/GenericHeap.java",
+        "src/main/java/com/thealgorithms/datastructures/lists/DoublyLinkedList.java",
+        "src/main/java/com/thealgorithms/datastructures/trees/CreateBinaryTreeFromInorderPreorder.java",
+        "src/main/java/com/thealgorithms/divideandconquer/ClosestPair.java",
+        "src/main/java/com/thealgorithms/dynamicprogramming/Fibonacci.java",
+        "src/main/java/com/thealgorithms/maths/NthUglyNumber.java",
+        "src/main/java/com/thealgorithms/maths/SimpsonIntegration.java",
+        "src/main/java/com/thealgorithms/others/Dijkstra.java",
+        "src/main/java/com/thealgorithms/sorts/TopologicalSort.java",
+        "src/main/java/com/thealgorithms/strings/AhoCorasick.java",
+        "src/test/java/com/thealgorithms/datastructures/caches/LRUCacheTest.java",
+        "src/test/java/com/thealgorithms/datastructures/lists/SkipListTest.java",
+        "src/test/java/com/thealgorithms/datastructures/trees/KDTreeTest.java",
+        "src/test/java/com/thealgorithms/datastructures/trees/LazySegmentTreeTest.java",
+        "src/test/java/com/thealgorithms/searches/QuickSelectTest.java",
+        "src/test/java/com/thealgorithms/stacks/PostfixToInfixTest.java",
+        "src/test/java/com/thealgorithms/strings/HorspoolSearchTest.java"
+    ]
+}

pom.xml

@@ -125,7 +125,7 @@
             <plugin>
                 <groupId>com.github.spotbugs</groupId>
                 <artifactId>spotbugs-maven-plugin</artifactId>
-                <version>4.8.6.3</version>
+                <version>4.8.6.4</version>
                 <configuration>
                     <excludeFilterFile>spotbugs-exclude.xml</excludeFilterFile>
                     <includeTests>true</includeTests>

src/main/java/com/thealgorithms/conversions/RomanToInteger.java

@@ -19,6 +19,10 @@ private RomanToInteger() {
         }
     };
 
+    private static int romanSymbolToInt(final char symbol) {
+        return ROMAN_TO_INT.computeIfAbsent(symbol, c -> { throw new IllegalArgumentException("Unknown Roman symbol: " + c); });
+    }
+
     // Roman Number = Roman Numerals
 
     /**
@@ -39,10 +43,10 @@ public static int romanToInt(String a) {
 
             if (prev != ' ') {
                 // checking current Number greater than previous or not
-                newPrev = ROMAN_TO_INT.get(prev) > newPrev ? ROMAN_TO_INT.get(prev) : newPrev;
+                newPrev = romanSymbolToInt(prev) > newPrev ? romanSymbolToInt(prev) : newPrev;
             }
 
-            int currentNum = ROMAN_TO_INT.get(c);
+            int currentNum = romanSymbolToInt(c);
 
             // if current number greater than prev max previous then add
             if (currentNum >= newPrev) {
@@ -57,9 +61,4 @@ public static int romanToInt(String a) {
 
         return sum;
     }
-
-    public static void main(String[] args) {
-        int sum = romanToInt("MDCCCIV");
-        System.out.println(sum);
-    }
 }

src/main/java/com/thealgorithms/conversions/UnitsConverter.java

@@ -3,6 +3,7 @@
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Map;
+import java.util.NoSuchElementException;
 import java.util.Set;
 import org.apache.commons.lang3.tuple.Pair;
 
@@ -77,7 +78,7 @@ public double convert(final String inputUnit, final String outputUnit, final dou
             throw new IllegalArgumentException("inputUnit must be different from outputUnit.");
         }
         final var conversionKey = Pair.of(inputUnit, outputUnit);
-        return conversions.get(conversionKey).convert(value);
+        return conversions.computeIfAbsent(conversionKey, k -> { throw new NoSuchElementException("No converter for: " + k); }).convert(value);
     }
 
     public Set<String> availableUnits() {

src/main/java/com/thealgorithms/misc/ColorContrastRatio.java

@@ -7,8 +7,7 @@
  * calculate contrast ratio between colors on the web. This is used to calculate
  * the readability of a foreground color on top of a background color.
  * @since 2020-10-15
- * @see [Color Contrast
- * Ratio](https://www.w3.org/TR/WCAG20-TECHS/G17.html#G17-procedure)
+ * @see <a href="https://www.w3.org/TR/WCAG20-TECHS/G17.html#G17-procedure">Color Contrast Ratio</a>
  * @author [Seth Falco](https://github.com/SethFalco)
  */
 public class ColorContrastRatio {
@@ -34,8 +33,7 @@ public double getContrastRatio(Color a, Color b) {
      * @brief Calculates the relative luminance of a given color.
      * @param color Any color, used to get the red, green, and blue values.
      * @return The relative luminance of the color.
-     * @see [More info on relative
-     * luminance.](https://www.w3.org/TR/2008/REC-WCAG20-20081211/#relativeluminancedef)
+     * @see <a href="https://www.w3.org/TR/2008/REC-WCAG20-20081211/#relativeluminancedef">More info on relative luminance.</a>
      */
     public double getRelativeLuminance(Color color) {
         final double red = getColor(color.getRed());
@@ -46,63 +44,21 @@ public double getRelativeLuminance(Color color) {
     }
 
     /**
-     * @brief Calculates the final value for a color to be used in the relative
-     * luminance formula as described in step 1.
+     * @brief Calculates the final value for a color to be used in the relative luminance formula as described in step 1.
      * @param color8Bit 8-bit representation of a color component value.
-     * @return Value for the provided color component to be used in the relative
-     * luminance formula.
+     * @return Value for the provided color component to be used in the relative luminance formula.
      */
     public double getColor(int color8Bit) {
         final double sRgb = getColorSRgb(color8Bit);
         return (sRgb <= 0.03928) ? sRgb / 12.92 : Math.pow((sRgb + 0.055) / 1.055, 2.4);
     }
 
     /**
-     * @brief Calculates the Color sRGB value as denoted in step 1 of the
-     * procedure document.
+     * @brief Calculates the Color sRGB value as denoted in step 1 of the procedure document.
      * @param color8Bit 8-bit representation of a color component value.
      * @return A percentile value of the color component.
      */
     private double getColorSRgb(double color8Bit) {
         return color8Bit / 255.0;
     }
-
-    /**
-     * You can check this example against another open-source implementation
-     * available on GitHub.
-     *
-     * @see [Online Contrast
-     * Ratio](https://contrast-ratio.com/#rgb%28226%2C%20229%2C%20248-on-rgb%2823%2C%20103%2C%20154%29)
-     * @see [GitHub Repository for Online Contrast
-     * Ratio](https://github.com/LeaVerou/contrast-ratio)
-     */
-    private static void test() {
-        final ColorContrastRatio algImpl = new ColorContrastRatio();
-
-        final Color black = Color.BLACK;
-        final double blackLuminance = algImpl.getRelativeLuminance(black);
-        assert blackLuminance == 0 : "Test 1 Failed - Incorrect relative luminance.";
-
-        final Color white = Color.WHITE;
-        final double whiteLuminance = algImpl.getRelativeLuminance(white);
-        assert whiteLuminance == 1 : "Test 2 Failed - Incorrect relative luminance.";
-
-        final double highestColorRatio = algImpl.getContrastRatio(black, white);
-        assert highestColorRatio == 21 : "Test 3 Failed - Incorrect contrast ratio.";
-
-        final Color foreground = new Color(23, 103, 154);
-        final double foregroundLuminance = algImpl.getRelativeLuminance(foreground);
-        assert foregroundLuminance == 0.12215748057375966 : "Test 4 Failed - Incorrect relative luminance.";
-
-        final Color background = new Color(226, 229, 248);
-        final double backgroundLuminance = algImpl.getRelativeLuminance(background);
-        assert backgroundLuminance == 0.7898468477881603 : "Test 5 Failed - Incorrect relative luminance.";
-
-        final double contrastRatio = algImpl.getContrastRatio(foreground, background);
-        assert contrastRatio == 4.878363954846178 : "Test 6 Failed - Incorrect contrast ratio.";
-    }
-
-    public static void main(String[] args) {
-        test();
-    }
 }

src/test/java/com/thealgorithms/conversions/RomanToIntegerTest.java

@@ -1,6 +1,7 @@
 package com.thealgorithms.conversions;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
 
 import org.junit.jupiter.api.Test;
 
@@ -10,5 +11,13 @@ public class RomanToIntegerTest {
     public void testRomanToInteger() {
         assertEquals(1994, RomanToInteger.romanToInt("MCMXCIV"));
         assertEquals(58, RomanToInteger.romanToInt("LVIII"));
+        assertEquals(1804, RomanToInteger.romanToInt("MDCCCIV"));
+    }
+
+    @Test
+    void testRomanToIntegerThrows() {
+        assertThrows(IllegalArgumentException.class, () -> RomanToInteger.romanToInt("Z"));
+        assertThrows(IllegalArgumentException.class, () -> RomanToInteger.romanToInt("MZI"));
+        assertThrows(IllegalArgumentException.class, () -> RomanToInteger.romanToInt("MMMO"));
     }
 }

src/test/java/com/thealgorithms/conversions/UnitsConverterTest.java

@@ -4,6 +4,7 @@
 import static org.junit.jupiter.api.Assertions.assertThrows;
 
 import java.util.Map;
+import java.util.NoSuchElementException;
 import org.apache.commons.lang3.tuple.Pair;
 import org.junit.jupiter.api.Test;
 
@@ -15,4 +16,12 @@ void testConvertThrowsForSameUnits() {
         assertThrows(IllegalArgumentException.class, () -> someConverter.convert("A", "A", 20.0));
         assertThrows(IllegalArgumentException.class, () -> someConverter.convert("B", "B", 20.0));
     }
+
+    @Test
+    void testConvertThrowsForUnknownUnits() {
+        final UnitsConverter someConverter = new UnitsConverter(Map.ofEntries(entry(Pair.of("A", "B"), new AffineConverter(10.0, -20.0))));
+        assertThrows(NoSuchElementException.class, () -> someConverter.convert("A", "X", 20.0));
+        assertThrows(NoSuchElementException.class, () -> someConverter.convert("X", "A", 20.0));
+        assertThrows(NoSuchElementException.class, () -> someConverter.convert("X", "Y", 20.0));
+    }
 }

src/test/java/com/thealgorithms/misc/ColorContrastRatioTest.java

@@ -0,0 +1,33 @@
+package com.thealgorithms.misc;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import java.awt.Color;
+import java.util.stream.Stream;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
+
+class ColorContrastRatioTest {
+    private final ColorContrastRatio colorContrastRationCalculator = new ColorContrastRatio();
+
+    static Stream<Arguments> relativeLuminanceProvider() {
+        return Stream.of(Arguments.of(Color.BLACK, 0.0), Arguments.of(Color.WHITE, 1.0), Arguments.of(new Color(23, 103, 154), 0.12215748057375966), Arguments.of(new Color(226, 229, 248), 0.7898468477881603));
+    }
+
+    static Stream<Arguments> contrastRatioProvider() {
+        return Stream.of(Arguments.of(Color.BLACK, Color.WHITE, 21.0), Arguments.of(new Color(23, 103, 154), new Color(226, 229, 248), 4.878363954846178));
+    }
+
+    @ParameterizedTest
+    @MethodSource("relativeLuminanceProvider")
+    void testGetRelativeLuminance(Color color, double expectedLuminance) {
+        assertEquals(expectedLuminance, colorContrastRationCalculator.getRelativeLuminance(color), 1e-10);
+    }
+
+    @ParameterizedTest
+    @MethodSource("contrastRatioProvider")
+    void testGetContrastRatio(Color a, Color b, double expectedRatio) {
+        assertEquals(expectedRatio, colorContrastRationCalculator.getContrastRatio(a, b), 1e-10);
+    }
+}