feat(compression): Add Burrows-Wheeler Transform (BWT) and Move-to-Front (MTF) (#6926)

* feat(compression): Add Burrows-Wheeler Transform (BWT) and Move-to-Front (MTF)

* Resolve SpotBugs

* fix code style
This commit is contained in:
Indolyn Yi
2025-10-25 17:29:45 +08:00
committed by GitHub
parent 48ba1ae466
commit ab65ac6485
4 changed files with 600 additions and 0 deletions

View File

@@ -0,0 +1,124 @@
package com.thealgorithms.compression;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
import org.junit.jupiter.api.Test;
public class BurrowsWheelerTransformTest {
@Test
public void testTransformAndInverseBanana() {
String original = "banana$";
BurrowsWheelerTransform.BWTResult expectedTransform = new BurrowsWheelerTransform.BWTResult("annb$aa", 4);
// Test forward transform
BurrowsWheelerTransform.BWTResult actualTransform = BurrowsWheelerTransform.transform(original);
assertEquals(expectedTransform, actualTransform);
// Test inverse transform
String reconstructed = BurrowsWheelerTransform.inverseTransform(actualTransform.transformed, actualTransform.originalIndex);
assertEquals(original, reconstructed);
}
@Test
public void testTransformAndInverseAbracadabra() {
String original = "abracadabra$";
BurrowsWheelerTransform.BWTResult expectedTransform = new BurrowsWheelerTransform.BWTResult("ard$rcaaaabb", 3);
// Test forward transform
BurrowsWheelerTransform.BWTResult actualTransform = BurrowsWheelerTransform.transform(original);
assertEquals(expectedTransform, actualTransform);
// Test inverse transform
String reconstructed = BurrowsWheelerTransform.inverseTransform(actualTransform.transformed, actualTransform.originalIndex);
assertEquals(original, reconstructed);
}
@Test
public void testTransformAndInverseSixMixPixFix() {
String original = "SIX.MIX.PIX.FIX$";
BurrowsWheelerTransform.BWTResult expectedTransform = new BurrowsWheelerTransform.BWTResult("XXXX.FPSM..$IIII", 11);
// Test forward transform
BurrowsWheelerTransform.BWTResult actualTransform = BurrowsWheelerTransform.transform(original);
assertEquals(expectedTransform, actualTransform);
// Test inverse transform
String reconstructed = BurrowsWheelerTransform.inverseTransform(actualTransform.transformed, actualTransform.originalIndex);
assertEquals(original, reconstructed);
}
@Test
public void testEmptyString() {
String original = "";
BurrowsWheelerTransform.BWTResult expectedTransform = new BurrowsWheelerTransform.BWTResult("", -1);
BurrowsWheelerTransform.BWTResult actualTransform = BurrowsWheelerTransform.transform(original);
assertEquals(expectedTransform, actualTransform);
String reconstructed = BurrowsWheelerTransform.inverseTransform(actualTransform.transformed, actualTransform.originalIndex);
assertEquals(original, reconstructed);
}
@Test
public void testSingleCharacter() {
String original = "a";
BurrowsWheelerTransform.BWTResult expectedTransform = new BurrowsWheelerTransform.BWTResult("a", 0);
BurrowsWheelerTransform.BWTResult actualTransform = BurrowsWheelerTransform.transform(original);
assertEquals(expectedTransform, actualTransform);
String reconstructed = BurrowsWheelerTransform.inverseTransform(actualTransform.transformed, actualTransform.originalIndex);
assertEquals(original, reconstructed);
}
@Test
public void testTransformNull() {
assertEquals(new BurrowsWheelerTransform.BWTResult("", -1), BurrowsWheelerTransform.transform(null));
}
@Test
public void testInverseTransformNullString() {
// bwtString == null
assertEquals("", BurrowsWheelerTransform.inverseTransform(null, 1));
// bwtString.isEmpty()
assertEquals("", BurrowsWheelerTransform.inverseTransform("", 0));
}
@Test
public void testInverseTransformIndexOutOfBounds() {
String bwt = "annb$aa";
int n = bwt.length(); // n = 7
// originalIndex >= n
assertThrows(IllegalArgumentException.class, () -> BurrowsWheelerTransform.inverseTransform(bwt, n));
assertThrows(IllegalArgumentException.class, () -> BurrowsWheelerTransform.inverseTransform(bwt, 8));
// originalIndex < 0
assertThrows(IllegalArgumentException.class, () -> BurrowsWheelerTransform.inverseTransform(bwt, -2));
}
@Test
public void testBWTResultHelpers() {
BurrowsWheelerTransform.BWTResult res1 = new BurrowsWheelerTransform.BWTResult("annb$aa", 4);
BurrowsWheelerTransform.BWTResult res2 = new BurrowsWheelerTransform.BWTResult("annb$aa", 4);
BurrowsWheelerTransform.BWTResult res3 = new BurrowsWheelerTransform.BWTResult("other", 4);
BurrowsWheelerTransform.BWTResult res4 = new BurrowsWheelerTransform.BWTResult("annb$aa", 1);
assertEquals(res1, res1);
assertEquals(res1, res2);
assertNotEquals(res1, null); // obj == null
assertNotEquals(res1, new Object()); // different class
assertNotEquals(res1, res3); // different transformed
assertNotEquals(res1, res4); // different originalIndex
assertEquals(res1.hashCode(), res2.hashCode());
assertNotEquals(res1.hashCode(), res3.hashCode());
assertTrue(res1.toString().contains("annb$aa"));
assertTrue(res1.toString().contains("originalIndex=4"));
}
}

View File

@@ -0,0 +1,92 @@
package com.thealgorithms.compression;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
import java.util.List;
import org.junit.jupiter.api.Test;
public class MoveToFrontTest {
@Test
public void testTransformAndInverseBananaExample() {
String original = "annb$aa";
String alphabet = "$abn";
List<Integer> expectedTransform = List.of(1, 3, 0, 3, 3, 3, 0);
// Test forward transform
List<Integer> actualTransform = MoveToFront.transform(original, alphabet);
assertEquals(expectedTransform, actualTransform);
// Test inverse transform
String reconstructed = MoveToFront.inverseTransform(actualTransform, alphabet);
assertEquals(original, reconstructed);
}
@Test
public void testTransformAndInverseCabaaExample() {
String original = "cabaa";
String alphabet = "abcdef";
List<Integer> expectedTransform = List.of(2, 1, 2, 1, 0);
// Test forward transform
List<Integer> actualTransform = MoveToFront.transform(original, alphabet);
assertEquals(expectedTransform, actualTransform);
// Test inverse transform
String reconstructed = MoveToFront.inverseTransform(actualTransform, alphabet);
assertEquals(original, reconstructed);
}
@Test
public void testEmptyInput() {
String original = "";
String alphabet = "abc";
List<Integer> expectedTransform = List.of();
List<Integer> actualTransform = MoveToFront.transform(original, alphabet);
assertEquals(expectedTransform, actualTransform);
String reconstructed = MoveToFront.inverseTransform(actualTransform, alphabet);
assertEquals(original, reconstructed);
}
@Test
public void testEmptyAlphabet() {
assertThrows(IllegalArgumentException.class, () -> MoveToFront.transform("abc", ""));
assertEquals("", MoveToFront.inverseTransform(List.of(1, 2), ""));
}
@Test
public void testSymbolNotInAlphabet() {
// 'd' is not in "abc"
assertThrows(IllegalArgumentException.class, () -> MoveToFront.transform("abd", "abc"));
}
@Test
public void testIndexOutOfBounds() {
// Index 5 is out of bounds for alphabet "abc"
// 1. test index >= alphabet.size()
assertThrows(IllegalArgumentException.class, () -> MoveToFront.inverseTransform(List.of(1, 2, 5), "abc"));
// 2. test index < 0
assertThrows(IllegalArgumentException.class, () -> MoveToFront.inverseTransform(List.of(1, -1, 2), "abc"));
}
@Test
public void testTransformNull() {
List<Integer> expected = List.of();
assertEquals(expected, MoveToFront.transform(null, "abc"));
assertThrows(IllegalArgumentException.class, () -> MoveToFront.transform("abc", null));
}
@Test
public void testInverseTransformNulls() {
// 1. test indices == null
assertEquals("", MoveToFront.inverseTransform(null, "abc"));
// 2. test initialAlphabet == null
assertEquals("", MoveToFront.inverseTransform(List.of(1, 2), null));
}
}