org.terrier.compression.integer.codec

Class IntegerCodec

java.lang.Object

org.terrier.compression.integer.codec.IntegerCodec

Direct Known Subclasses:

GammaCodec, LemireCodec, UnaryCodec, VIntCodec

public abstract class IntegerCodec
extends Object

Abstract class representing an integer codec

Since:

4.0

Author:

Matteo Catena

Field Summary

Fields

Modifier and Type	Field and Description
protected ByteBuffer	inBuffer
protected ByteBuffer	outBuffer
protected int[]	supportArray

Constructor Summary

Constructors

Constructor and Description
IntegerCodec()

Method Summary

Modifier and Type	Method and Description
abstract void	compress(int[] in, int len, ByteOut out) Compress and write down an integer array
abstract void	decompress(ByteIn in, int[] out, int num) Read and decompress an integer array
abstract void	skip(ByteIn in) avoid to decompress the next block (the size of the block is written on the input stream)
String	toString() returns a textual description of the codec

Methods inherited from class java.lang.Object

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

Field Detail

inBuffer

protected ByteBuffer inBuffer

outBuffer

protected ByteBuffer outBuffer

supportArray

protected int[] supportArray

Constructor Detail

IntegerCodec

public IntegerCodec()

Method Detail

compress

public abstract void compress(int[] in,
                              int len,
                              ByteOut out)
                       throws IOException

Compress and write down an integer array

Parameters:

in - the array to compress

len - number of in's elements to compress

out - the output channel

Throws:

IOException

decompress

public abstract void decompress(ByteIn in,
                                int[] out,
                                int num)
                         throws IOException

Read and decompress an integer array

Parameters:

in - the input channel

out - the decompressed array

num - expected number of decompressed elements

Throws:

IOException

skip

public abstract void skip(ByteIn in)
                   throws IOException

avoid to decompress the next block (the size of the block is written on the input stream)

Parameters:

in - the input channel

Throws:

IOException

toString

public String toString()

returns a textual description of the codec

Overrides:

toString in class Object