com.simiacryptus.util.binary.codes

Class HammingCode<T extends Comparable<T>>

java.lang.Object

com.simiacryptus.util.binary.codes.HammingCode<T>

Type Parameters:

T - the type parameter

public class HammingCode<T extends Comparable<T>>
extends Object

The type Hamming run.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	HammingCode.HammingCodeCollection The type Hamming run collection.

Field Summary

Fields

Modifier and Type	Field and Description
protected TreeMap<Bits,T>	forwardIndex The Forward index.
protected HashMap<T,Bits>	reverseIndex The Reverse index.
protected long	totalWeight The Total weight.
protected HashMap<T,Integer>	weights The Weights.

Constructor Summary

Constructors

Constructor and Description
HammingCode(Collection<HammingSymbol<T>> symbols) Instantiates a new Hamming run.

Method Summary

Modifier and Type	Method and Description
int	codeSize() Code size int.
T	decode(BitInputStream in) Decode t.
Map.Entry<Bits,T>	decode(Bits data) Decode entry.
Bits	encode(T key) Encode bits.
SortedMap<Bits,T>	getCodes(Bits fromKey) Gets codes.
CountTreeBitsCollection	getSetEncoder() Gets set encoder.
CountTreeBitsCollection	getSetEncoder(BitInputStream data) Gets set encoder.
CountTreeBitsCollection	getSetEncoder(byte[] data) Gets set encoder.
Map<T,Integer>	getWeights() Gets weights.
static boolean	isPrefixFreeCode(Set<Bits> keySet) Is prefix free run boolean.
int	totalWeight() Total weight int.
boolean	verifyIndexes() Verify indexes boolean.

Methods inherited from class java.lang.Object

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

Field Detail

forwardIndex

protected final TreeMap<Bits,T extends Comparable<T>> forwardIndex

The Forward index.

reverseIndex

protected final HashMap<T extends Comparable<T>,Bits> reverseIndex

The Reverse index.

weights

protected final HashMap<T extends Comparable<T>,Integer> weights

The Weights.

totalWeight

protected final long totalWeight

The Total weight.

Constructor Detail

HammingCode

public HammingCode(Collection<HammingSymbol<T>> symbols)

Instantiates a new Hamming run.

Parameters:

symbols - the symbols

Method Detail

isPrefixFreeCode

public static boolean isPrefixFreeCode(Set<Bits> keySet)

Is prefix free run boolean.

Parameters:

keySet - the key set

Returns:

the boolean

codeSize

public int codeSize()

Code size int.

Returns:

the int

decode

public T decode(BitInputStream in)
         throws IOException

Decode t.

Parameters:

in - the in

Returns:

the t

Throws:

IOException - the io exception

decode

public Map.Entry<Bits,T> decode(Bits data)

Decode entry.

Parameters:

data - the data

Returns:

the entry

encode

public Bits encode(T key)

Encode bits.

Parameters:

key - the key

Returns:

the bits

getCodes

public SortedMap<Bits,T> getCodes(Bits fromKey)

Gets codes.

Parameters:

fromKey - the from key

Returns:

the codes

getSetEncoder

public CountTreeBitsCollection getSetEncoder()

Gets set encoder.

Returns:

the set encoder

getSetEncoder

public CountTreeBitsCollection getSetEncoder(BitInputStream data)
                                      throws IOException

Gets set encoder.

Parameters:

data - the data

Returns:

the set encoder

Throws:

IOException - the io exception

getSetEncoder

public CountTreeBitsCollection getSetEncoder(byte[] data)
                                      throws IOException

Gets set encoder.

Parameters:

data - the data

Returns:

the set encoder

Throws:

IOException - the io exception

getWeights

public Map<T,Integer> getWeights()

Gets weights.

Returns:

the weights

verifyIndexes

public boolean verifyIndexes()

Verify indexes boolean.

Returns:

the boolean

totalWeight

public int totalWeight()

Total weight int.

Returns:

the int