Skip to content

refactor: add parameterized tests for BitSwap #6347

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions src/main/java/com/thealgorithms/bitmanipulation/BitSwap.java
Original file line number Diff line number Diff line change
@@ -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);
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,62 @@
package com.thealgorithms.bitmanipulation;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;

import org.junit.jupiter.api.Test;
public class BitSwapTest {
@Test
void testHighestSetBit() {
assertEquals(3, BitSwap.bitSwap(3, 0, 1));
assertEquals(5, BitSwap.bitSwap(6, 0, 1));
assertEquals(7, BitSwap.bitSwap(7, 1, 1));
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 BitSwapTest {

@ParameterizedTest(name = "Additional cases: data={0}, posA={1}, posB={2} -> expected={3}")
@MethodSource("provideAdditionalCases")
void testAdditionalCases(int data, int posA, int posB, int expected) {
assertEquals(expected, BitSwap.bitSwap(data, posA, posB));
}

@ParameterizedTest(name = "Swap different bits: data={0}, posA={1}, posB={2} -> expected={3}")
@MethodSource("provideDifferentBitsCases")
void swapDifferentBits(int data, int posA, int posB, int expected) {
assertEquals(expected, BitSwap.bitSwap(data, posA, posB));
}

@ParameterizedTest(name = "Swap same bits: data={0}, posA={1}, posB={2} should not change")
@MethodSource("provideSameBitsCases")
void swapSameBits(int data, int posA, int posB) {
assertEquals(data, BitSwap.bitSwap(data, posA, posB));
}

@ParameterizedTest(name = "Edge cases: data={0}, posA={1}, posB={2} -> expected={3}")
@MethodSource("provideEdgeCases")
void testEdgeCases(int data, int posA, int posB, int expected) {
assertEquals(expected, BitSwap.bitSwap(data, posA, posB));
}

@ParameterizedTest(name = "Invalid positions: data={0}, posA={1}, posB={2} should throw")
@MethodSource("provideInvalidPositions")
void invalidPositionThrowsException(int data, int posA, int posB) {
assertThrows(IllegalArgumentException.class, () -> BitSwap.bitSwap(data, posA, posB));
}

static Stream<Arguments> provideAdditionalCases() {
return Stream.of(Arguments.of(3, 0, 1, 3), Arguments.of(6, 0, 1, 5), Arguments.of(7, 1, 1, 7));
}

static Stream<Arguments> provideDifferentBitsCases() {
return Stream.of(Arguments.of(0b01, 0, 1, 0b10));
}

static Stream<Arguments> provideSameBitsCases() {
return Stream.of(Arguments.of(0b111, 0, 2), Arguments.of(0b0, 1, 3), Arguments.of(0b1010, 1, 3), Arguments.of(-1, 5, 5));
}

static Stream<Arguments> provideEdgeCases() {
return Stream.of(Arguments.of(Integer.MIN_VALUE, 31, 0, 1), Arguments.of(0, 0, 31, 0));
}

static Stream<Arguments> provideInvalidPositions() {
return Stream.of(Arguments.of(0, -1, 0), Arguments.of(0, 0, 32), Arguments.of(0, -5, 33), Arguments.of(0, Integer.MIN_VALUE, Integer.MAX_VALUE));
}
}
Loading