Package me.lemire.integercompression

Class VariableByte

java.lang.Object

me.lemire.integercompression.VariableByte

All Implemented Interfaces:

ByteIntegerCODEC, IntegerCODEC, SkippableIntegerCODEC

public class VariableByte
extends Object
implements IntegerCODEC, ByteIntegerCODEC, SkippableIntegerCODEC

Implementation of variable-byte. For best performance, use it using the ByteIntegerCODEC interface. Note that this does not use differential coding: if you are working on sorted lists, you must compute the deltas separately.

Author:

Daniel Lemire

Constructor Summary

Constructors

Constructor	Description
VariableByte()

Method Summary

Modifier and Type	Method	Description
void	compress(int[] in, IntWrapper inpos, int inlength, byte[] out, IntWrapper outpos)	Compress data from an array to another array.
void	compress(int[] in, IntWrapper inpos, int inlength, int[] out, IntWrapper outpos)	Compress data from an array to another array.
void	headlessCompress(int[] in, IntWrapper inpos, int inlength, int[] out, IntWrapper outpos)	Compress data from an array to another array.
void	headlessUncompress(int[] in, IntWrapper inpos, int inlength, int[] out, IntWrapper outpos, int num)	Uncompress data from an array to another array.
protected ByteBuffer	makeBuffer(int sizeInBytes)	Creates a new buffer of the requested size.
String	toString()
void	uncompress(byte[] in, IntWrapper inpos, int inlength, int[] out, IntWrapper outpos)	Uncompress data from an array to another array.
void	uncompress(int[] in, IntWrapper inpos, int inlength, int[] out, IntWrapper outpos)	Uncompress data from an array to another array.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

VariableByte

public VariableByte()

Method Details

compress

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

Description copied from interface: IntegerCODEC

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 ints, then inpos will be incremented by 12 while outpos will be incremented by 3. We use IntWrapper to pass the values by reference.

Specified by:

compress in interface IntegerCODEC

Parameters:

in - input array

inpos - where to start reading in the array

inlength - how many integers to compress

out - output array

outpos - where to write in the output array

headlessCompress

public void headlessCompress(int[] in,
 IntWrapper inpos,
 int inlength,
 int[] out,
 IntWrapper outpos)

Description copied from interface: SkippableIntegerCODEC

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 ints, then inpos will be incremented by 12 while outpos will be incremented by 3. We use IntWrapper to pass the values by reference. Implementation note: contrary to IntegerCODEC.compress(int[], me.lemire.integercompression.IntWrapper, int, int[], me.lemire.integercompression.IntWrapper), this may skip writing information about the number of encoded integers.

Specified by:

headlessCompress in interface SkippableIntegerCODEC

Parameters:

in - input array

inpos - where to start reading in the array

inlength - how many integers to compress

out - output array

outpos - where to write in the output array

compress

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

Description copied from interface: ByteIntegerCODEC

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.

Specified by:

compress in interface ByteIntegerCODEC

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

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

Description copied from interface: IntegerCODEC

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

Specified by:

uncompress in interface IntegerCODEC

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 start writing the uncompressed output in out

uncompress

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

Description copied from interface: ByteIntegerCODEC

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

Specified by:

uncompress in interface ByteIntegerCODEC

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

toString

public String toString()

Overrides:

toString in class Object

headlessUncompress

public void headlessUncompress(int[] in,
 IntWrapper inpos,
 int inlength,
 int[] out,
 IntWrapper outpos,
 int num)

Description copied from interface: SkippableIntegerCODEC

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

Specified by:

headlessUncompress in interface SkippableIntegerCODEC

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 uncompressed output

outpos - where to start writing the uncompressed output in out

num - number of integers we want to decode. May be less than the actual number of compressed integers

makeBuffer

protected ByteBuffer makeBuffer(int sizeInBytes)

Creates a new buffer of the requested size. In case you need a different way to allocate buffers, you can override this method with a custom behavior. The default implementation allocates a new Java direct ByteBuffer on each invocation.

Parameters:

sizeInBytes -

Returns: