README.md

bitutils

The BitUtils project provides bit packing utilities to serialize data in units of 1, 2 or 4 bits.

Serialize boolean values using 1 bit for every value

File dataFile = new File("booleans.bin");
boolean[] values = new boolean[] { true, true, false, true, false, false, false, true, false, true };

// Writing
Buffer1BitWriter writer = new Buffer1BitWriter(dataFile, values.length);
try {
  for (int i = 0; i < values.length; i++) {
    writer.write(values[i] ? 1 : 0);
  }
} finally {
  writer.close();
}

// Reading
Buffer1BitReader reader = new Buffer1BitReader(dataFile);
try {
  
  // Read next value
  boolean value0 = reader.read() == 1;
  
  // Read a value at the specified position
  boolean value4 = reader.read(4) == 1;
  
} finally {
  reader.close();
}

Serialize integer values from 0 to 3 (inclusive) using 2 bits for every value

File dataFile = new File("numbers.bin");
int[] values = new int[] { 0, 1, 2, 3, 2, 1, 0, 3, 1, 2 };

// Writing
BufferBitWriter writer = new BufferBitWriter(dataFile, BitListSize.Size2, values.length);
try {
  for (int i = 0; i < values.length; i++) {
    writer.write(values[i]);
  }
} finally {
  writer.close();
}

// Reading
BufferBitReader reader = new BufferBitReader(dataFile, BitListSize.Size2);
try {
  
  // Read next value
  int value0 = reader.read();

  // Read a value at the specified position
  int value4 = reader.read(4);
  
} finally {
  reader.close();
}

Serialize integer values from 0 to 15 (inclusive) using 4 bits for every value

File dataFile = new File("numbers.bin");
int[] values = new int[] { 12, 1, 13, 9, 7, 5, 8, 15, 3, 4 };

// Writing
BufferBitWriter writer = new BufferBitWriter(dataFile, BitListSize.Size4, values.length);
try {
  for (int i = 0; i < values.length; i++) {
    writer.write(values[i]);
  }
} finally {
  writer.close();
}

// Reading
BufferBitReader reader = new BufferBitReader(dataFile, BitListSize.Size4);
try {
  
  // Read next value
  int value0 = reader.read();

  // Read a value at the specified position
  int value4 = reader.read(4);
  
} finally {
  reader.close();
}

Maven Configuration

<dependency>
  <groupId>it.yobibit</groupId>
  <artifactId>bitutils</artifactId>
  <version>0.6</version>
</dependency>