Merge branch 'master' into master

Author: riti2601

.github/workflows/build.yml

@@ -10,7 +10,7 @@ jobs:
         uses: actions/setup-java@v4
         with:
           java-version: 21
-          distribution: 'adopt'
+          distribution: 'temurin'
       - name: Build with Maven
         run: mvn --batch-mode --update-snapshots verify
       - name: Upload coverage to codecov (tokenless)

.github/workflows/codeql.yml

@@ -30,7 +30,7 @@ jobs:
         uses: actions/setup-java@v4
         with:
           java-version: 21
-          distribution: 'adopt'
+          distribution: 'temurin'
 
       - name: Initialize CodeQL
         uses: github/codeql-action/init@v3

.github/workflows/infer.yml

@@ -18,7 +18,7 @@ jobs:
         uses: actions/setup-java@v4
         with:
           java-version: 21
-          distribution: 'adopt'
+          distribution: 'temurin'
 
       - name: Set up OCaml
         uses: ocaml/setup-ocaml@v3

DIRECTORY.md

@@ -183,7 +183,7 @@
     <!-- See https://checkstyle.org/checks/misc/index.html -->
     <module name="ArrayTypeStyle"/>
     <!-- TODO <module name="FinalParameters"/> -->
-    <!-- TODO <module name="TodoComment"/> -->
+    <module name="TodoComment"/>
     <module name="UpperEll"/>
 
     <!-- https://checkstyle.org/filters/suppressionxpathfilter.html -->

checkstyle.xml

@@ -40,6 +40,13 @@
             <version>${assertj.version}</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <version>5.14.1</version>
+            <scope>test</scope>
+        </dependency>
+
 
         <dependency>
             <groupId>org.junit.jupiter</groupId>

pom.xml

@@ -0,0 +1,82 @@
+package com.thealgorithms.bitmanipulation;
+
+/**
+ * This class provides methods to convert between BCD (Binary-Coded Decimal) and decimal numbers.
+ *
+ * BCD is a class of binary encodings of decimal numbers where each decimal digit is represented by a fixed number of binary digits, usually four or eight.
+ *
+ * For more information, refer to the
+ * <a href="https://en.wikipedia.org/wiki/Binary-coded_decimal">Binary-Coded Decimal</a> Wikipedia page.
+ *
+ * <b>Example usage:</b>
+ * <pre>
+ * int decimal = BcdConversion.bcdToDecimal(0x1234);
+ * System.out.println("BCD 0x1234 to decimal: " + decimal); // Output: 1234
+ *
+ * int bcd = BcdConversion.decimalToBcd(1234);
+ * System.out.println("Decimal 1234 to BCD: " + Integer.toHexString(bcd)); // Output: 0x1234
+ * </pre>
+ */
+public final class BcdConversion {
+    private BcdConversion() {
+    }
+
+    /**
+     * Converts a BCD (Binary-Coded Decimal) number to a decimal number.
+     * <p>Steps:
+     * <p>1. Validate the BCD number to ensure all digits are between 0 and 9.
+     * <p>2. Extract the last 4 bits (one BCD digit) from the BCD number.
+     * <p>3. Multiply the extracted digit by the corresponding power of 10 and add it to the decimal number.
+     * <p>4. Shift the BCD number right by 4 bits to process the next BCD digit.
+     * <p>5. Repeat steps 1-4 until the BCD number is zero.
+     *
+     * @param bcd The BCD number.
+     * @return The corresponding decimal number.
+     * @throws IllegalArgumentException if the BCD number contains invalid digits.
+     */
+    public static int bcdToDecimal(int bcd) {
+        int decimal = 0;
+        int multiplier = 1;
+
+        // Validate BCD digits
+        while (bcd > 0) {
+            int digit = bcd & 0xF;
+            if (digit > 9) {
+                throw new IllegalArgumentException("Invalid BCD digit: " + digit);
+            }
+            decimal += digit * multiplier;
+            multiplier *= 10;
+            bcd >>= 4;
+        }
+        return decimal;
+    }
+
+    /**
+     * Converts a decimal number to BCD (Binary-Coded Decimal).
+     * <p>Steps:
+     * <p>1. Check if the decimal number is within the valid range for BCD (0 to 9999).
+     * <p>2. Extract the last decimal digit from the decimal number.
+     * <p>3. Shift the digit to the correct BCD position and add it to the BCD number.
+     * <p>4. Remove the last decimal digit from the decimal number.
+     * <p>5. Repeat steps 2-4 until the decimal number is zero.
+     *
+     * @param decimal The decimal number.
+     * @return The corresponding BCD number.
+     * @throws IllegalArgumentException if the decimal number is greater than 9999.
+     */
+    public static int decimalToBcd(int decimal) {
+        if (decimal < 0 || decimal > 9999) {
+            throw new IllegalArgumentException("Value out of bounds for BCD representation: " + decimal);
+        }
+
+        int bcd = 0;
+        int shift = 0;
+        while (decimal > 0) {
+            int digit = decimal % 10;
+            bcd |= (digit << (shift * 4));
+            decimal /= 10;
+            shift++;
+        }
+        return bcd;
+    }
+}

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

@@ -0,0 +1,43 @@
+package com.thealgorithms.bitmanipulation;
+
+/**
+ * This class contains a method to check if the binary representation of a number is a palindrome.
+ * <p>
+ *     A binary palindrome is a number whose binary representation is the same when read from left to right and right to left.
+ *     For example, the number 9 has a binary representation of 1001, which is a palindrome.
+ *     The number 10 has a binary representation of 1010, which is not a palindrome.
+ * </p>
+ *
+ * @author Hardvan
+ */
+public final class BinaryPalindromeCheck {
+    private BinaryPalindromeCheck() {
+    }
+
+    /**
+     * Checks if the binary representation of a number is a palindrome.
+     *
+     * @param x The number to check.
+     * @return True if the binary representation is a palindrome, otherwise false.
+     */
+    public static boolean isBinaryPalindrome(int x) {
+        int reversed = reverseBits(x);
+        return x == reversed;
+    }
+
+    /**
+     * Helper function to reverse all the bits of an integer.
+     *
+     * @param x The number to reverse the bits of.
+     * @return The number with reversed bits.
+     */
+    private static int reverseBits(int x) {
+        int result = 0;
+        while (x > 0) {
+            result <<= 1;
+            result |= (x & 1);
+            x >>= 1;
+        }
+        return result;
+    }
+}

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

@@ -0,0 +1,111 @@
+package com.thealgorithms.bitmanipulation;
+
+import java.util.List;
+
+/**
+ * Implements various Boolean algebra gates (AND, OR, NOT, XOR, NAND, NOR)
+ */
+public final class BooleanAlgebraGates {
+
+    private BooleanAlgebraGates() {
+        // Prevent instantiation
+    }
+
+    /**
+     * Represents a Boolean gate that takes multiple inputs and returns a result.
+     */
+    interface BooleanGate {
+        /**
+         * Evaluates the gate with the given inputs.
+         *
+         * @param inputs The input values for the gate.
+         * @return The result of the evaluation.
+         */
+        boolean evaluate(List<Boolean> inputs);
+    }
+
+    /**
+     * AND Gate implementation.
+     * Returns true if all inputs are true; otherwise, false.
+     */
+    static class ANDGate implements BooleanGate {
+        @Override
+        public boolean evaluate(List<Boolean> inputs) {
+            for (boolean input : inputs) {
+                if (!input) {
+                    return false;
+                }
+            }
+            return true;
+        }
+    }
+
+    /**
+     * OR Gate implementation.
+     * Returns true if at least one input is true; otherwise, false.
+     */
+    static class ORGate implements BooleanGate {
+        @Override
+        public boolean evaluate(List<Boolean> inputs) {
+            for (boolean input : inputs) {
+                if (input) {
+                    return true;
+                }
+            }
+            return false;
+        }
+    }
+
+    /**
+     * NOT Gate implementation (Unary operation).
+     * Negates a single input value.
+     */
+    static class NOTGate {
+        /**
+         * Evaluates the negation of the input.
+         *
+         * @param input The input value to be negated.
+         * @return The negated value.
+         */
+        public boolean evaluate(boolean input) {
+            return !input;
+        }
+    }
+
+    /**
+     * XOR Gate implementation.
+     * Returns true if an odd number of inputs are true; otherwise, false.
+     */
+    static class XORGate implements BooleanGate {
+        @Override
+        public boolean evaluate(List<Boolean> inputs) {
+            boolean result = false;
+            for (boolean input : inputs) {
+                result ^= input;
+            }
+            return result;
+        }
+    }
+
+    /**
+     * NAND Gate implementation.
+     * Returns true if at least one input is false; otherwise, false.
+     */
+    static class NANDGate implements BooleanGate {
+        @Override
+        public boolean evaluate(List<Boolean> inputs) {
+            return !new ANDGate().evaluate(inputs); // Equivalent to negation of AND
+        }
+    }
+
+    /**
+     * NOR Gate implementation.
+     * Returns true if all inputs are false; otherwise, false.
+     */
+    static class NORGate implements BooleanGate {
+        @Override
+        public boolean evaluate(List<Boolean> inputs) {
+            return !new ORGate().evaluate(inputs); // Equivalent to negation of OR
+        }
+    }
+}

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

@@ -0,0 +1,39 @@
+package com.thealgorithms.bitmanipulation;
+
+/**
+ * ClearLeftmostSetBit class contains a method to clear the leftmost set bit of a number.
+ * The leftmost set bit is the leftmost bit that is set to 1 in the binary representation of a number.
+ *
+ * Example:
+ * 26 (11010) -> 10 (01010)
+ * 1 (1) -> 0 (0)
+ * 7 (111) -> 3 (011)
+ * 6 (0110) -> 2 (0010)
+ *
+ * @author Hardvan
+ */
+public final class ClearLeftmostSetBit {
+    private ClearLeftmostSetBit() {
+    }
+
+    /**
+     * Clears the leftmost set bit (1) of a given number.
+     * Step 1: Find the position of the leftmost set bit
+     * Step 2: Create a mask with all bits set except for the leftmost set bit
+     * Step 3: Clear the leftmost set bit using AND with the mask
+     *
+     * @param num The input number.
+     * @return The number after clearing the leftmost set bit.
+     */
+    public static int clearLeftmostSetBit(int num) {
+        int pos = 0;
+        int temp = num;
+        while (temp > 0) {
+            temp >>= 1;
+            pos++;
+        }
+
+        int mask = ~(1 << (pos - 1));
+        return num & mask;
+    }
+}

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

@@ -0,0 +1,39 @@
+package com.thealgorithms.bitmanipulation;
+
+/**
+ * CountLeadingZeros class contains a method to count the number of leading zeros in the binary representation of a number.
+ * The number of leading zeros is the number of zeros before the leftmost 1 bit.
+ * For example, the number 5 has 29 leading zeros in its 32-bit binary representation.
+ * The number 0 has 32 leading zeros.
+ * The number 1 has 31 leading zeros.
+ * The number -1 has no leading zeros.
+ *
+ * @author Hardvan
+ */
+public final class CountLeadingZeros {
+    private CountLeadingZeros() {
+    }
+
+    /**
+     * Counts the number of leading zeros in the binary representation of a number.
+     * Method: Keep shifting the mask to the right until the leftmost bit is 1.
+     * The number of shifts is the number of leading zeros.
+     *
+     * @param num The input number.
+     * @return The number of leading zeros.
+     */
+    public static int countLeadingZeros(int num) {
+        if (num == 0) {
+            return 32;
+        }
+
+        int count = 0;
+        int mask = 1 << 31;
+        while ((mask & num) == 0) {
+            count++;
+            mask >>>= 1;
+        }
+
+        return count;
+    }
+}