org.terrier.compression.integer.codec

Class LemireCodec

java.lang.Object

org.terrier.compression.integer.codec.IntegerCodec

org.terrier.compression.integer.codec.LemireCodec

Direct Known Subclasses:

KamikazePForDeltaVBCodec, LemireFastPFORVBCodec, LemireFORVBCodec, LemireNewPFDVBCodec, LemireOptPFDVBCodec, LemireSimple16Codec

public class LemireCodec
extends IntegerCodec

Generic IntegerCodec implementation which wraps any SkippableIntegerCODEC from the JavaFastPFOR package. A generic set of SkippableIntegerCODECs can also be specified using String parameters to the constructor.

Since:

4.0

Author:

Matteo Catena and Craig Macdonald

Field Summary

Fields inherited from class org.terrier.compression.integer.codec.IntegerCodec

inBuffer, outBuffer, supportArray

Constructor Summary

Constructors

Constructor and Description
LemireCodec(me.lemire.integercompression.SkippableIntegerCODEC codec)
LemireCodec(String[] params)

Method Summary

Methods

Modifier and Type	Method and Description
void	compress(int[] in, int len, ByteOut out) Compress and write down an integer array
void	decompress(ByteIn in, int[] out, int num) Read and decompress an integer array
static me.lemire.integercompression.SkippableIntegerCODEC	getCODEC(String[] params)
void	skip(ByteIn in) avoid to decompress the next block (the size of the block is written on the input stream)

Methods inherited from class org.terrier.compression.integer.codec.IntegerCodec

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

LemireCodec

public LemireCodec(String[] params)
            throws Exception

Throws:

Exception

LemireCodec

public LemireCodec(me.lemire.integercompression.SkippableIntegerCODEC codec)

Method Detail

compress

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

Description copied from class: IntegerCodec

Compress and write down an integer array

Specified by:

compress in class IntegerCodec

Parameters:

in - the array to compress

len - number of in's elements to compress

out - the output channel

Throws:

IOException

decompress

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

Description copied from class: IntegerCodec

Read and decompress an integer array

Specified by:

decompress in class IntegerCodec

Parameters:

in - the input channel

out - the decompressed array

num - expected number of decompressed elements

Throws:

IOException

skip

public final void skip(ByteIn in)
                throws IOException

Description copied from class: IntegerCodec

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

Specified by:

skip in class IntegerCodec

Parameters:

in - the input channel

Throws:

IOException

getCODEC

public static me.lemire.integercompression.SkippableIntegerCODEC getCODEC(String[] params)
                                                                   throws Exception

Throws:

Exception