htsjdk.samtools.cram.encoding.core.huffmanUtils

Class HuffmanBitCode<T>

java.lang.Object

htsjdk.samtools.cram.encoding.core.huffmanUtils.HuffmanBitCode<T>

Type Parameters:

T - type of the symbols in the alphabet being huffman-encoded

public final class HuffmanBitCode<T>
extends java.lang.Object

Huffman bit code word consisting of a symbol, the corresponding codeword and codeword bit length.

Constructor Summary

Constructors

Constructor and Description
HuffmanBitCode(T symbol, int codeWord, int codeWordBitLength)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBitCodeWithPrefix()
int	getCodeWord()
int	getCodeWordBitLength()
T	getSymbol()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HuffmanBitCode

public HuffmanBitCode(T symbol,
                      int codeWord,
                      int codeWordBitLength)

Method Detail

getSymbol

public T getSymbol()

Returns:

the symbol for this bit code

getCodeWord

public int getCodeWord()

Returns:

the codeword for this bit code

getCodeWordBitLength

public int getCodeWordBitLength()

Returns:

the codeword bit length for this bit code

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getBitCodeWithPrefix

public java.lang.String getBitCodeWithPrefix()

Returns:

the codeword for this bit code as a String, padded out to codeWordBitLength with leading zeros