org.terrier.realtime.compression

Class MemBitSetBuffer

java.lang.Object

org.terrier.realtime.compression.MemBitSetBuffer

All Implemented Interfaces:

Closeable, AutoCloseable, BitIn, BitOut

public class MemBitSetBuffer
extends Object
implements BitOut, BitIn

Buffer backed by a BitSet. Supports gamma and unary encoding of strictly positive integers.

Since:

4.0

Field Summary

Fields inherited from interface org.terrier.compression.bit.BitIn

USUAL_EXTENSION

Constructor Summary

Constructors

Constructor and Description
MemBitSetBuffer() Constructor (64 bits).
MemBitSetBuffer(MemBitSetBuffer copy) Copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	align() Not Implemented.
void	close() Not Implemented.
byte	getBitOffset() Not Implemented.
long	getByteOffset() Not Implemented.
int	readBinary(int len) Not Implemented.
int	readDelta() Not Implemented.
int	readGamma() Gamma decoding.
int	readGolomb(int b) Not Implemented.
void	readInterpolativeCoding(int[] data, int offset, int len, int lo, int hi) Not Implemented.
int	readMinimalBinary(int b) Not Implemented.
int	readMinimalBinaryZero(int b) Not Implemented.
int	readSkewedGolomb(int b) Not Implemented.
int	readUnary() Unary decoding.
void	skipBits(int len) Not Implemented.
void	skipBytes(long len) Not Implemented.
int	writeBinary(int len, int x) Not Implemented.
int	writeDelta(int x) Not Implemented.
int	writeGamma(int n) Gamma encoding.
int	writeGolomb(int x, int b) Not Implemented.
int	writeInt(int x, int len) Not Implemented.
int	writeInterpolativeCode(int[] data, int offset, int len, int lo, int hi) Not Implemented.
int	writeMinimalBinary(int x, int b) Not Implemented.
int	writeSkewedGolomb(int x, int b) Not Implemented.
int	writeUnary(int n) Unary encoding.

Methods inherited from class java.lang.Object

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

Constructor Detail

MemBitSetBuffer

public MemBitSetBuffer()

Constructor (64 bits).

MemBitSetBuffer

public MemBitSetBuffer(MemBitSetBuffer copy)

Copy constructor.

Method Detail

writeUnary

public int writeUnary(int n)

Unary encoding. Write n-1 1s, then 0.

Specified by:

writeUnary in interface BitOut

Parameters:

n - the number to write

Returns:

the number of bits written

writeGamma

public int writeGamma(int n)

Gamma encoding. Take n in binary. Pad left nbits-1 0s.

Specified by:

writeGamma in interface BitOut

Parameters:

n - the int number to write

Returns:

the number of bits written

readUnary

public int readUnary()

Unary decoding. Count 1s until 0 seen. Return 1s + 1.

Specified by:

readUnary in interface BitIn

Returns:

the number read

readGamma

public int readGamma()

Gamma decoding. Count 0s until 1 seen. From 1 read 0s bits as binary int.

Specified by:

readGamma in interface BitIn

Returns:

the number read

readBinary

public int readBinary(int len)
               throws IOException

Not Implemented.

Specified by:

readBinary in interface BitIn

Parameters:

len - the number of binary bits to read

Returns:

the decoded integer

Throws:

IOException - if an I/O error occurs

readMinimalBinary

public int readMinimalBinary(int b)
                      throws IOException

Not Implemented.

Specified by:

readMinimalBinary in interface BitIn

Parameters:

b - the upper bound

Returns:

the int read

Throws:

IOException - if an I/O error occurs

readMinimalBinaryZero

public int readMinimalBinaryZero(int b)
                          throws IOException

Not Implemented.

Specified by:

readMinimalBinaryZero in interface BitIn

Parameters:

b - the upper bound

Returns:

the int read

Throws:

IOException - if an I/O error occurs

readGolomb

public int readGolomb(int b)
               throws IOException

Not Implemented.

Specified by:

readGolomb in interface BitIn

Parameters:

b - the golomb modulus

Returns:

the int read

Throws:

IOException - if and I/O error occurs

readSkewedGolomb

public int readSkewedGolomb(int b)
                     throws IOException

Not Implemented.

Specified by:

readSkewedGolomb in interface BitIn

Returns:

the number read

Throws:

IOException - if an I/O error occurs

readDelta

public int readDelta()
              throws IOException

Not Implemented.

Specified by:

readDelta in interface BitIn

Returns:

the number read

Throws:

IOException - if an I/O error occurs

readInterpolativeCoding

public void readInterpolativeCoding(int[] data,
                           int offset,
                           int len,
                           int lo,
                           int hi)
                             throws IOException

Not Implemented.

Specified by:

readInterpolativeCoding in interface BitIn

Parameters:

data - the result vector

offset - offset where to write in the vector

len - the number of integers to decode.

lo - a lower bound (the same one passed to writeInterpolativeCoding)

hi - an upper bound (the same one passed to writeInterpolativeCoding)

Throws:

IOException - if an I/O error occurs

skipBits

public void skipBits(int len)
              throws IOException

Not Implemented.

Specified by:

skipBits in interface BitIn

Parameters:

len - The number of bits to skip

Throws:

IOException - if an I/O error occurs

skipBytes

public void skipBytes(long len)
               throws IOException

Not Implemented.

Specified by:

skipBytes in interface BitIn

Parameters:

len - The number of bytes to skip

Throws:

IOException - if an I/O error occurs

align

public void align()
           throws IOException

Not Implemented.

Specified by:

align in interface BitIn

Throws:

IOException - if an I/O error occurs

getByteOffset

public long getByteOffset()

Not Implemented.

Specified by:

getByteOffset in interface BitIn

Specified by:

getByteOffset in interface BitOut

Returns:

the byte offset in the stream.

getBitOffset

public byte getBitOffset()

Not Implemented.

Specified by:

getBitOffset in interface BitIn

Specified by:

getBitOffset in interface BitOut

Returns:

the bit offset in the stream.

writeBinary

public int writeBinary(int len,
              int x)
                throws IOException

Not Implemented.

Specified by:

writeBinary in interface BitOut

Parameters:

len - size in bits of the number.

x - the integer to write.

Returns:

the number of bits written.

Throws:

IOException - if an I/O error occurs.

writeInterpolativeCode

public int writeInterpolativeCode(int[] data,
                         int offset,
                         int len,
                         int lo,
                         int hi)
                           throws IOException

Not Implemented.

Specified by:

writeInterpolativeCode in interface BitOut

Parameters:

data - the vector containing the integer sequence.

offset - the offset into data where the sequence starts.

len - the number of integers to code.

lo - a lower bound (must be smaller than or equal to the first integer in the sequence).

hi - an upper bound (must be greater than or equal to the last integer in the sequence).

Returns:

the number of written bits.

Throws:

IOException - if an I/O error occurs.

writeSkewedGolomb

public int writeSkewedGolomb(int x,
                    int b)
                      throws IOException

Not Implemented.

Specified by:

writeSkewedGolomb in interface BitOut

Parameters:

x - the number to write

b - the parameter for golomb coding

Returns:

the number of bits written

Throws:

IOException - if and I/O error occurs

writeGolomb

public int writeGolomb(int x,
              int b)
                throws IOException

Not Implemented.

Specified by:

writeGolomb in interface BitOut

Parameters:

x - the number to write

b - the parameter for golomb coding

Returns:

the number of bits written

Throws:

IOException - if and I/O error occurs

writeMinimalBinary

public int writeMinimalBinary(int x,
                     int b)
                       throws IOException

Not Implemented.

Specified by:

writeMinimalBinary in interface BitOut

Parameters:

x - the number to write

b - and strict bound for x

Returns:

the number of bits written

Throws:

IOException - if an I/O error occurs.

writeDelta

public int writeDelta(int x)
               throws IOException

Not Implemented.

Specified by:

writeDelta in interface BitOut

Parameters:

x - the int number to write

Returns:

the number of bits written

Throws:

IOException - if an I/O error occurs.

writeInt

public int writeInt(int x,
           int len)
             throws IOException

Not Implemented.

Specified by:

writeInt in interface BitOut

Parameters:

x - the int to write

len - length of the int in bits

Returns:

the number of bits written

Throws:

IOException - if an I/O error occurs.

close

public void close()
           throws IOException

Not Implemented.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException