gnu.trove
Class TByteShortHashMap

java.lang.Object
  gnu.trove.THash
      gnu.trove.TPrimitiveHash
          gnu.trove.TByteHash
              gnu.trove.TByteShortHashMap

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable, TByteHashingStrategy

public class TByteShortHashMap

extends TByteHash

implements java.io.Serializable

An open addressed Map implementation for byte keys and short values. Created: Sun Nov 4 08:52:45 2001

Version:

$Id: TByteShortHashMap.java,v 1.2 2005/03/26 17:52:55 ericdf Exp $

Author:

Eric D. Friedman

See Also:

Serialized Form

Field Summary

protected short[]

_values the values of the map

Fields inherited from class gnu.trove.TByteHash

_hashingStrategy, _set

Fields inherited from class gnu.trove.TPrimitiveHash

_states, FREE, FULL, REMOVED

Fields inherited from class gnu.trove.THash

_free, _loadFactor, _maxSize, _size, DEFAULT_INITIAL_CAPACITY, DEFAULT_LOAD_FACTOR

Constructor Summary

TByteShortHashMap()
Creates a new TByteShortHashMap instance with the default capacity and load factor.

TByteShortHashMap(int initialCapacity)
Creates a new TByteShortHashMap instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.

TByteShortHashMap(int initialCapacity, float loadFactor)
Creates a new TByteShortHashMap instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.

TByteShortHashMap(int initialCapacity, float loadFactor, TByteHashingStrategy strategy)
Creates a new TByteShortHashMap instance with a prime value at or near the specified capacity and load factor.

TByteShortHashMap(int initialCapacity, TByteHashingStrategy strategy)
Creates a new TByteShortHashMap instance whose capacity is the next highest prime above initialCapacity + 1 unless that value is already prime.

TByteShortHashMap(TByteHashingStrategy strategy)
Creates a new TByteShortHashMap instance with the default capacity and load factor.

Method Summary

boolean	adjustValue(byte key, short amount) Adjusts the primitive value mapped to key.
void	clear() Empties the map.
java.lang.Object	clone()
boolean	containsKey(byte key) checks for the present of key in the keys of the map.
boolean	containsValue(short val) checks for the presence of val in the values of the map.
boolean	equals(java.lang.Object other) Compares this map with another map for equality of their stored entries.
boolean	forEachEntry(TByteShortProcedure procedure) Executes procedure for each key/value entry in the map.
boolean	forEachKey(TByteProcedure procedure) Executes procedure for each key in the map.
boolean	forEachValue(TShortProcedure procedure) Executes procedure for each value in the map.
short	get(byte key) retrieves the value for key
short[]	getValues() Returns the values of the map.
int	hashCode()
boolean	increment(byte key) Increments the primitive value mapped to key by 1
TByteShortIterator	iterator()
byte[]	keys() returns the keys of the map.
short	put(byte key, short value) Inserts a key/value pair into the map.
protected void	rehash(int newCapacity) rehashes the map to the new capacity.
short	remove(byte key) Deletes a key/value pair from the map.
protected void	removeAt(int index) removes the mapping at index from the map.
boolean	retainEntries(TByteShortProcedure procedure) Retains only those entries in the map for which the procedure returns a true value.
protected int	setUp(int initialCapacity) initializes the hashtable to a prime capacity which is at least initialCapacity + 1.
void	transformValues(TShortFunction function) Transform the values in this map using function.

Methods inherited from class gnu.trove.TByteHash

computeHashCode, contains, forEach, index, insertionIndex

Methods inherited from class gnu.trove.TPrimitiveHash

capacity

Methods inherited from class gnu.trove.THash

compact, ensureCapacity, isEmpty, postInsertHook, size, trimToSize

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

_values

protected transient short[] _values

the values of the map

Constructor Detail

TByteShortHashMap

public TByteShortHashMap()

Creates a new TByteShortHashMap instance with the default capacity and load factor.

TByteShortHashMap

public TByteShortHashMap(int initialCapacity)

Creates a new TByteShortHashMap instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.

Parameters:

initialCapacity - an int value

TByteShortHashMap

public TByteShortHashMap(int initialCapacity,
                         float loadFactor)

Creates a new TByteShortHashMap instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.

Parameters:

initialCapacity - an int value

loadFactor - a float value

TByteShortHashMap

public TByteShortHashMap(TByteHashingStrategy strategy)

Creates a new TByteShortHashMap instance with the default capacity and load factor.

Parameters:

strategy - used to compute hash codes and to compare keys.

TByteShortHashMap

public TByteShortHashMap(int initialCapacity,
                         TByteHashingStrategy strategy)

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

Parameters:

initialCapacity - an int value

strategy - used to compute hash codes and to compare keys.

TByteShortHashMap

public TByteShortHashMap(int initialCapacity,
                         float loadFactor,
                         TByteHashingStrategy strategy)

Creates a new TByteShortHashMap 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.

strategy - used to compute hash codes and to compare keys.

Method Detail

clone

public java.lang.Object clone()

Overrides:

clone in class TByteHash

Returns:

a deep clone of this collection

iterator

public TByteShortIterator iterator()

Returns:

a TByteShortIterator with access to this map's keys and values

setUp

protected int setUp(int initialCapacity)

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

Overrides:

setUp in class TByteHash

Parameters:

initialCapacity - an int value

Returns:

the actual capacity chosen

put

public short put(byte key,
                 short value)

Inserts a key/value pair into the map.

Parameters:

key - an byte value

value - an short value

Returns:

the previous value associated with key, or (short)0 if none was found.

rehash

protected void rehash(int newCapacity)

rehashes the map to the new capacity.

Specified by:

rehash in class THash

Parameters:

newCapacity - an int value

get

public short get(byte key)

retrieves the value for key

Parameters:

key - an byte value

Returns:

the value of key or (short)0 if no such mapping exists.

clear

public void clear()

Empties the map.

Overrides:

clear in class THash

remove

public short remove(byte key)

Deletes a key/value pair from the map.

Parameters:

key - an byte value

Returns:

an short value, or (short)0 if no mapping for key exists

equals

public boolean equals(java.lang.Object other)

Compares this map with another map for equality of their stored entries.

Parameters:

other - an Object value

Returns:

a boolean value

hashCode

public int hashCode()

removeAt

protected void removeAt(int index)

removes the mapping at index from the map.

Overrides:

removeAt in class TByteHash

Parameters:

index - an int value

getValues

public short[] getValues()

Returns the values of the map.

Returns:

a Collection value

keys

public byte[] keys()

returns the keys of the map.

Returns:

a Set value

containsValue

public boolean containsValue(short val)

checks for the presence of val in the values of the map.

Parameters:

val - an short value

Returns:

a boolean value

containsKey

public boolean containsKey(byte key)

checks for the present of key in the keys of the map.

Parameters:

key - an byte value

Returns:

a boolean value

forEachKey

public boolean forEachKey(TByteProcedure procedure)

Executes procedure for each key in the map.

Parameters:

procedure - a TByteProcedure value

Returns:

false if the loop over the keys terminated because the procedure returned false for some key.

forEachValue

public boolean forEachValue(TShortProcedure procedure)

Executes procedure for each value in the map.

Parameters:

procedure - a TShortProcedure value

Returns:

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

forEachEntry

public boolean forEachEntry(TByteShortProcedure procedure)

Executes procedure for each key/value entry in the map.

Parameters:

procedure - a TOByteShortProcedure value

Returns:

false if the loop over the entries terminated because the procedure returned false for some entry.

retainEntries

public boolean retainEntries(TByteShortProcedure procedure)

Retains only those entries in the map for which the procedure returns a true value.

Parameters:

procedure - determines which entries to keep

Returns:

true if the map was modified.

transformValues

public void transformValues(TShortFunction function)

Transform the values in this map using function.

Parameters:

function - a TShortFunction value

increment

public boolean increment(byte key)

Increments the primitive value mapped to key by 1

Parameters:

key - the key of the value to increment

Returns:

true if a mapping was found and modified.

adjustValue

public boolean adjustValue(byte key,
                           short amount)

Adjusts the primitive value mapped to key.

Parameters:

key - the key of the value to increment

amount - the amount to adjust the value by.

Returns:

true if a mapping was found and modified.