it.unimi.dsi.compression

Class HuffmanCodec.DecoderInputs

java.lang.Object

it.unimi.dsi.compression.HuffmanCodec.DecoderInputs

Enclosing class:

HuffmanCodec

public static class HuffmanCodec.DecoderInputs
extends Object

Class encapsulates the data necessary to reconstruct a CanonicalFast64CodeWordDecoder or recreate the code.

Version:

$Id: HuffmanCodec.java 2265 2009-10-26 12:51:06Z thompsonbry $

Author:

Bryan Thompson

Constructor Summary

Constructors

Constructor and Description
HuffmanCodec.DecoderInputs() Ctor may be passed to HuffmanCodec to obtain the assigned length[] and symbol[] data and the shortest code word.
HuffmanCodec.DecoderInputs(BitVector shortestCodeWord, int[] length, int[] symbol) Ctor may be used to explicitly populate an instance with the caller's data.

Method Summary

Methods

Modifier and Type	Method and Description
int[]	getLengths() Return the codeWord bit lengths in the non-decreasing order used to construct the CanonicalFast64CodeWordDecoder.
BitVector	getShortestCodeWord() The shortest code word.
int[]	getSymbols() Return the symbol[] in the permuted order used to construct the CanonicalFast64CodeWordDecoder.

Methods inherited from class java.lang.Object

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

Constructor Detail

HuffmanCodec.DecoderInputs

public HuffmanCodec.DecoderInputs()

Ctor may be passed to HuffmanCodec to obtain the assigned length[] and symbol[] data and the shortest code word.

HuffmanCodec.DecoderInputs

public HuffmanCodec.DecoderInputs(BitVector shortestCodeWord,
                          int[] length,
                          int[] symbol)

Ctor may be used to explicitly populate an instance with the caller's data.

Parameters:

shortestCodeWord -

length -

symbol -

Method Detail

getShortestCodeWord

public BitVector getShortestCodeWord()

The shortest code word. Note that canonical huffman codes can be recreated from just length[0] and the shortest code word.

getSymbols

public int[] getSymbols()

Return the symbol[] in the permuted order used to construct the CanonicalFast64CodeWordDecoder. This information is transient.

getLengths

public int[] getLengths()

Return the codeWord bit lengths in the non-decreasing order used to construct the CanonicalFast64CodeWordDecoder. This information is transient.