gnu.trove.impl.hash

Class TCharCharHash

java.lang.Object

gnu.trove.impl.hash.THash

gnu.trove.impl.hash.TPrimitiveHash

gnu.trove.impl.hash.TCharCharHash

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

Direct Known Subclasses:

TCharCharHashMap

public abstract class TCharCharHash
extends TPrimitiveHash

An open addressed hashing implementation for char/char primitive entries. Created: Sun Nov 4 08:56:06 2001

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
char[]	_set the set of chars
protected boolean	consumeFreeSlot
protected char	no_entry_key key that represents null NOTE: should not be modified after the Hash is created, but is not final because of Externalization
protected char	no_entry_value value that represents null NOTE: should not be modified after the Hash is created, but is not final because of Externalization

Fields inherited from class gnu.trove.impl.hash.TPrimitiveHash

_states, FREE, FULL, REMOVED

Fields inherited from class gnu.trove.impl.hash.THash

_autoCompactionFactor, _autoCompactRemovesRemaining, _autoCompactTemporaryDisable, _free, _loadFactor, _maxSize, _size, DEFAULT_CAPACITY, DEFAULT_LOAD_FACTOR

Constructor Summary

Constructors

Constructor and Description
TCharCharHash() Creates a new T#E#Hash instance with the default capacity and load factor.
TCharCharHash(int initialCapacity) Creates a new T#E#Hash instance whose capacity is the next highest prime above initialCapacity + 1 unless that value is already prime.
TCharCharHash(int initialCapacity, float loadFactor) Creates a new TCharCharHash instance with a prime value at or near the specified capacity and load factor.
TCharCharHash(int initialCapacity, float loadFactor, char no_entry_key, char no_entry_value) Creates a new TCharCharHash instance with a prime value at or near the specified capacity and load factor.

Method Summary

Modifier and Type	Method and Description
boolean	contains(char val) Searches the set for val
boolean	forEach(TCharProcedure procedure) Executes procedure for each key in the map.
char	getNoEntryKey() Returns the value that is used to represent null as a key.
char	getNoEntryValue() Returns the value that is used to represent null.
protected int	index(char key) Locates the index of val.
protected int	insertKey(char val) Locates the index at which val can be inserted.
void	readExternal(java.io.ObjectInput in)
protected void	removeAt(int index) Releases the element currently stored at index.
protected int	setUp(int initialCapacity) initializes the hashtable to a prime capacity which is at least initialCapacity + 1.
void	writeExternal(java.io.ObjectOutput out)
protected int	XinsertKey(char key)

Methods inherited from class gnu.trove.impl.hash.TPrimitiveHash

capacity

Methods inherited from class gnu.trove.impl.hash.THash

calculateGrownCapacity, clear, compact, computeMaxSize, computeNextAutoCompactionAmount, ensureCapacity, fastCeil, getAutoCompactionFactor, isEmpty, postInsertHook, reenableAutoCompaction, rehash, saturatedCast, setAutoCompactionFactor, size, tempDisableAutoCompaction, trimToSize

Methods inherited from class java.lang.Object

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

Field Detail

_set

public transient char[] _set

the set of chars

no_entry_key

protected char no_entry_key

key that represents null NOTE: should not be modified after the Hash is created, but is not final because of Externalization

no_entry_value

protected char no_entry_value

value that represents null NOTE: should not be modified after the Hash is created, but is not final because of Externalization

consumeFreeSlot

protected boolean consumeFreeSlot

Constructor Detail

TCharCharHash

public TCharCharHash()

Creates a new T#E#Hash instance with the default capacity and load factor.

TCharCharHash

public TCharCharHash(int initialCapacity)

Creates a new T#E#Hash instance whose capacity is the next highest prime above initialCapacity + 1 unless that value is already prime.

Parameters:

initialCapacity - an int value

TCharCharHash

public TCharCharHash(int initialCapacity,
                     float loadFactor)

Creates a new TCharCharHash instance with a prime value at or near the specified capacity and load factor.

Parameters:

initialCapacity - used to find a prime capacity for the table.

loadFactor - used to calculate the threshold over which rehashing takes place.

TCharCharHash

public TCharCharHash(int initialCapacity,
                     float loadFactor,
                     char no_entry_key,
                     char no_entry_value)

Creates a new TCharCharHash instance with a prime value at or near the specified capacity and load factor.

Parameters:

initialCapacity - used to find a prime capacity for the table.

loadFactor - used to calculate the threshold over which rehashing takes place.

no_entry_value - value that represents null

Method Detail

getNoEntryKey

public char getNoEntryKey()

Returns the value that is used to represent null as a key. The default value is generally zero, but can be changed during construction of the collection.

Returns:

the value that represents null

getNoEntryValue

public char getNoEntryValue()

Returns the value that is used to represent null. The default value is generally zero, but can be changed during construction of the collection.

Returns:

the value that represents null

setUp

protected int setUp(int initialCapacity)

initializes the hashtable to a prime capacity which is at least initialCapacity + 1.

Overrides:

setUp in class TPrimitiveHash

Parameters:

initialCapacity - an int value

Returns:

the actual capacity chosen

contains

public boolean contains(char val)

Searches the set for val

Parameters:

val - an char value

Returns:

a boolean value

forEach

public boolean forEach(TCharProcedure procedure)

Executes procedure for each key in the map.

Parameters:

procedure - a TCharProcedure value

Returns:

false if the loop over the set terminated because the procedure returned false for some value.

removeAt

protected void removeAt(int index)

Releases the element currently stored at index.

Overrides:

removeAt in class TPrimitiveHash

Parameters:

index - an int value

index

protected int index(char key)

Locates the index of val.

Parameters:

key - an char value

Returns:

the index of val or -1 if it isn't in the set.

insertKey

protected int insertKey(char val)

Locates the index at which val can be inserted. if there is already a value equal()ing val in the set, returns that value as a negative integer.

Parameters:

val - an char value

Returns:

an int value

XinsertKey

protected int XinsertKey(char key)

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Overrides:

writeExternal in class THash

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Overrides:

readExternal in class THash

Throws:

java.io.IOException

java.lang.ClassNotFoundException