org.terrier.compression.integer.codec.util

Class BitInCodec

java.lang.Object

org.terrier.compression.bit.BitInBase

org.terrier.compression.integer.codec.util.BitInCodec

All Implemented Interfaces:

Closeable, AutoCloseable, BitIn

public class BitInCodec
extends BitInBase

Utility class, used to implement bitwise IntegerCodec implementations

Since:

4.0

Author:

Matteo Catena

Field Summary

Fields inherited from class org.terrier.compression.bit.BitInBase

bitOffset, byteRead, offset

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

USUAL_EXTENSION

Constructor Summary

Constructors

Constructor and Description
BitInCodec()
BitInCodec(byte[] input)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
protected void	incrByte() Move forward one byte.
protected void	incrByte(int i) Move forward i bytes.
void	setup(ByteIn in, int bytes)
void	skipBytes(long len) Skip a number of bytes while reading the bit file.

Methods inherited from class org.terrier.compression.bit.BitInBase

align, getBitOffset, getByteOffset, readBinary, readDelta, readGamma, readGolomb, readIn, readInterpolativeCoding, readMinimalBinary, readMinimalBinaryZero, readSkewedGolomb, readUnary, skipBits

Methods inherited from class java.lang.Object

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

Constructor Detail

BitInCodec

public BitInCodec()

BitInCodec

public BitInCodec(byte[] input)

Method Detail

skipBytes

public void skipBytes(long len)
               throws IOException

Description copied from interface: BitIn

Skip a number of bytes while reading the bit file. After this opteration, getBitOffset() == 0, so use skipBits(int) to get getBitOffset() to desired value.

Parameters:

len - The number of bytes to skip

Throws:

IOException - if an I/O error occurs

close

public void close()
           throws IOException

Throws:

IOException

incrByte

protected final void incrByte()
                       throws IOException

Description copied from class: BitInBase

Move forward one byte. The newly read byte should appear in the byteRead variable.

Specified by:

incrByte in class BitInBase

Throws:

IOException

incrByte

protected final void incrByte(int i)
                       throws IOException

Description copied from class: BitInBase

Move forward i bytes. The newly read byte should appear in byteRead variable.

Specified by:

incrByte in class BitInBase

Throws:

IOException

setup

public final void setup(ByteIn in,
         int bytes)
                 throws IOException

Throws:

IOException