gnu.trove
Class TShortShortHashMap

java.lang.Object
  gnu.trove.THash
      gnu.trove.TPrimitiveHash
          gnu.trove.TShortHash
              gnu.trove.TShortShortHashMap

All Implemented Interfaces:

TShortHashingStrategy, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable

public class TShortShortHashMap
extends TShortHash
implements java.io.Externalizable

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

Author:

Eric D. Friedman

See Also:

Serialized Form

Field Summary

protected short[]

_values the values of the map

Fields inherited from class gnu.trove.TShortHash

_hashingStrategy, _set

Fields inherited from class gnu.trove.TPrimitiveHash

_states, FREE, FULL, REMOVED

Fields inherited from class gnu.trove.THash

_autoCompactionFactor, _autoCompactRemovesRemaining, _free, _loadFactor, _maxSize, _size, DEFAULT_INITIAL_CAPACITY, DEFAULT_LOAD_FACTOR

Constructor Summary

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

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

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

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

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

TShortShortHashMap(TShortHashingStrategy strategy)
Creates a new TShortShortHashMap instance with the default capacity and load factor.

Method Summary

short	adjustOrPutValue(short key, short adjust_amount, short put_amount) Adjusts the primitive value mapped to the key if the key is present in the map.
boolean	adjustValue(short key, short amount) Adjusts the primitive value mapped to key.
void	clear() Empties the map.
java.lang.Object	clone()
boolean	containsKey(short 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(TShortShortProcedure procedure) Executes procedure for each key/value entry in the map.
boolean	forEachKey(TShortProcedure procedure) Executes procedure for each key in the map.
boolean	forEachValue(TShortProcedure procedure) Executes procedure for each value in the map.
short	get(short key) retrieves the value for key
short[]	getValues() Returns the values of the map.
int	hashCode()
boolean	increment(short key) Increments the primitive value mapped to key by 1
TShortShortIterator	iterator()
short[]	keys() returns the keys of the map.
short[]	keys(short[] a) returns the keys of the map.
short	put(short key, short value) Inserts a key/value pair into the map.
void	readExternal(java.io.ObjectInput in)
protected void	rehash(int newCapacity) rehashes the map to the new capacity.
short	remove(short key) Deletes a key/value pair from the map.
protected void	removeAt(int index) removes the mapping at index from the map.
boolean	retainEntries(TShortShortProcedure 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.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class gnu.trove.TShortHash

computeHashCode, contains, forEach, index, insertionIndex

Methods inherited from class gnu.trove.TPrimitiveHash

capacity

Methods inherited from class gnu.trove.THash

calculateGrownCapacity, compact, ensureCapacity, getAutoCompactionFactor, isEmpty, postInsertHook, reenableAutoCompaction, setAutoCompactionFactor, size, tempDisableAutoCompaction, 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

TShortShortHashMap

public TShortShortHashMap()

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

TShortShortHashMap

public TShortShortHashMap(int initialCapacity)

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

Parameters:

initialCapacity - an int value

TShortShortHashMap

public TShortShortHashMap(int initialCapacity,
                          float loadFactor)

Creates a new TShortShortHashMap 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

TShortShortHashMap

public TShortShortHashMap(TShortHashingStrategy strategy)

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

Parameters:

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

TShortShortHashMap

public TShortShortHashMap(int initialCapacity,
                          TShortHashingStrategy strategy)

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

TShortShortHashMap

public TShortShortHashMap(int initialCapacity,
                          float loadFactor,
                          TShortHashingStrategy strategy)

Creates a new TShortShortHashMap 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 TShortHash

Returns:

a deep clone of this collection

iterator

public TShortShortIterator iterator()

Returns:

a TShortShortIterator 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 TShortHash

Parameters:

initialCapacity - an int value

Returns:

the actual capacity chosen

put

public short put(short key,
                 short value)

Inserts a key/value pair into the map.

Parameters:

key - an short 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(short key)

retrieves the value for key

Parameters:

key - an short 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(short key)

Deletes a key/value pair from the map.

Parameters:

key - an short 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.

Overrides:

equals in class java.lang.Object

Parameters:

other - an Object value

Returns:

a boolean value

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

removeAt

protected void removeAt(int index)

removes the mapping at index from the map.

Overrides:

removeAt in class TShortHash

Parameters:

index - an int value

getValues

public short[] getValues()

Returns the values of the map.

Returns:

a Collection value

keys

public short[] keys()

returns the keys of the map.

Returns:

a Set value

keys

public short[] keys(short[] a)

returns the keys of the map.

Parameters:

a - the array into which the elements of the list are to be stored, if it is big enough; otherwise, a new array of the same type is allocated for this purpose.

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(short key)

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

Parameters:

key - an short value

Returns:

a boolean value

forEachKey

public boolean forEachKey(TShortProcedure procedure)

Executes procedure for each key in the map.

Parameters:

procedure - a TShortProcedure 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(TShortShortProcedure procedure)

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

Parameters:

procedure - a TOShortShortProcedure value

Returns:

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

retainEntries

public boolean retainEntries(TShortShortProcedure 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(short 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(short 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.

adjustOrPutValue

public short adjustOrPutValue(short key,
                              short adjust_amount,
                              short put_amount)

Adjusts the primitive value mapped to the key if the key is present in the map. Otherwise, the initial_value is put in the map.

Parameters:

key - the key of the value to increment

adjust_amount - the amount to adjust the value by

put_amount - the value put into the map if the key is not initial present

Returns:

the value present in the map after the adjustment or put operation

Since:

2.0b1

writeExternal

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

Specified by:

writeExternal in interface java.io.Externalizable

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

Throws:

java.io.IOException

java.lang.ClassNotFoundException