me.lemire.integercompression
Interface ByteIntegerCODEC

All Known Subinterfaces:

IntegratedByteIntegerCODEC

All Known Implementing Classes:

IntegratedVariableByte, VariableByte

public interface ByteIntegerCODEC

Interface describing a CODEC to compress integers to bytes.

Author:

Daniel Lemire

Method Summary

void	compress(int[] in, IntWrapper inpos, int inlength, byte[] out, IntWrapper outpos) Compress data from an array to another array.
void	uncompress(byte[] in, IntWrapper inpos, int inlength, int[] out, IntWrapper outpos) Uncompress data from an array to another array.

Method Detail

compress

void compress(int[] in,
              IntWrapper inpos,
              int inlength,
              byte[] out,
              IntWrapper outpos)

Compress data from an array to another array. Both inpos and outpos are modified to represent how much data was read and written to if 12 ints (inlength = 12) are compressed to 3 bytes, then inpos will be incremented by 12 while outpos will be incremented by 3 we use IntWrapper to pass the values by reference.

Parameters:

in - input array

inpos - location in the input array

inlength - how many integers to compress

out - output array

outpos - where to write in the output array

uncompress

void uncompress(byte[] in,
                IntWrapper inpos,
                int inlength,
                int[] out,
                IntWrapper outpos)

Uncompress data from an array to another array. Both inpos and outpos parameters are modified to indicate new positions after read/write.

Parameters:

in - array containing data in compressed form

inpos - where to start reading in the array

inlength - length of the compressed data (ignored by some schemes)

out - array where to write the compressed output

outpos - where to write the compressed output in out