htsjdk.samtools.cram.encoding.core.huffmanUtils

Class HuffmanParams<T>

java.lang.Object

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

Type Parameters:

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

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

A class for carrying around encoding parameters for a canonical Huffman encoder. The HuffmanParams consist of an array of symbols and an array of corresponding codeWordLengths. The actual codewords themselves are not part of the params since they can be recalculated on demand. Therefore, the params are independent of the canonicalization state (the "canonical" huffman params are the same as the non-canonical params for a given set of symbol/frequencies; it is only the code words themselves are different after canonicalization; the code word lengths are the preserved).

Constructor Summary

Constructors

Constructor and Description
HuffmanParams(java.util.List<T> symbols, java.util.List<java.lang.Integer> codeWordLengths)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.util.List<java.lang.Integer>	getCodeWordLengths()
java.util.List<T>	getSymbols()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HuffmanParams

public HuffmanParams(java.util.List<T> symbols,
                     java.util.List<java.lang.Integer> codeWordLengths)

Parameters:

symbols - symbols being encoded

codeWordLengths - code word lengths for each symbol

Method Detail

getSymbols

public java.util.List<T> getSymbols()

Returns:

the list of symbols for these params

getCodeWordLengths

public java.util.List<java.lang.Integer> getCodeWordLengths()

Returns:

the list of code word bit lengths for these params

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object