gnu.trove
Class TIntIntHashMap

java.lang.Object
  |
  +--gnu.trove.THash
        |
        +--gnu.trove.TPrimitiveHash
              |
              +--gnu.trove.TIntHash
                    |
                    +--gnu.trove.TIntIntHashMap

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable, TIntHashingStrategy

public class TIntIntHashMap

extends TIntHash

implements java.io.Serializable

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

Version:

$Id: TIntIntHashMap.java,v 1.15 2003/11/21 17:32:30 ericdf Exp $

Author:

Eric D. Friedman

See Also:

Serialized Form

Field Summary

protected int[]

_values the values of the map

Fields inherited from class gnu.trove.TIntHash

_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

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

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

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

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

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

TIntIntHashMap(TIntHashingStrategy strategy)
Creates a new TIntIntHashMap instance with the default capacity and load factor.

Method Summary

boolean	adjustValue(int key, int amount) Adjusts the primitive value mapped to key.
void	clear() Empties the map.
java.lang.Object	clone()
boolean	containsKey(int key) checks for the present of key in the keys of the map.
boolean	containsValue(int 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(TIntIntProcedure procedure) Executes procedure for each key/value entry in the map.
boolean	forEachKey(TIntProcedure procedure) Executes procedure for each key in the map.
boolean	forEachValue(TIntProcedure procedure) Executes procedure for each value in the map.
int	get(int key) retrieves the value for key
int[]	getValues() Returns the values of the map.
int	hashCode()
boolean	increment(int key) Increments the primitive value mapped to key by 1
TIntIntIterator	iterator()
int[]	keys() returns the keys of the map.
int	put(int key, int value) Inserts a key/value pair into the map.
protected void	rehash(int newCapacity) rehashes the map to the new capacity.
int	remove(int key) Deletes a key/value pair from the map.
protected void	removeAt(int index) removes the mapping at index from the map.
boolean	retainEntries(TIntIntProcedure 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(TIntFunction function) Transform the values in this map using function.

Methods inherited from class gnu.trove.TIntHash

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 int[] _values

the values of the map

Constructor Detail

TIntIntHashMap

public TIntIntHashMap()

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

TIntIntHashMap

public TIntIntHashMap(int initialCapacity)

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

Parameters:

initialCapacity - an int value

TIntIntHashMap

public TIntIntHashMap(int initialCapacity,
                      float loadFactor)

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

TIntIntHashMap

public TIntIntHashMap(TIntHashingStrategy strategy)

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

Parameters:

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

TIntIntHashMap

public TIntIntHashMap(int initialCapacity,
                      TIntHashingStrategy strategy)

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

TIntIntHashMap

public TIntIntHashMap(int initialCapacity,
                      float loadFactor,
                      TIntHashingStrategy strategy)

Creates a new TIntIntHashMap 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 TIntHash

Returns:

a deep clone of this collection

iterator

public TIntIntIterator iterator()

Returns:

a TIntIntIterator 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 TIntHash

Parameters:

initialCapacity - an int value

Returns:

the actual capacity chosen

put

public int put(int key,
               int value)

Inserts a key/value pair into the map.

Parameters:

key - an int value

value - an int value

Returns:

the previous value associated with key, or (int)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 int get(int key)

retrieves the value for key

Parameters:

key - an int value

Returns:

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

clear

public void clear()

Empties the map.

Overrides:

clear in class THash

remove

public int remove(int key)

Deletes a key/value pair from the map.

Parameters:

key - an int value

Returns:

an int value, or (int)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 TIntHash

Parameters:

index - an int value

getValues

public int[] getValues()

Returns the values of the map.

Returns:

a Collection value

keys

public int[] keys()

returns the keys of the map.

Returns:

a Set value

containsValue

public boolean containsValue(int val)

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

Parameters:

val - an int value

Returns:

a boolean value

containsKey

public boolean containsKey(int key)

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

Parameters:

key - an int value

Returns:

a boolean value

forEachKey

public boolean forEachKey(TIntProcedure procedure)

Executes procedure for each key in the map.

Parameters:

procedure - a TIntProcedure value

Returns:

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

forEachValue

public boolean forEachValue(TIntProcedure procedure)

Executes procedure for each value in the map.

Parameters:

procedure - a TIntProcedure value

Returns:

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

forEachEntry

public boolean forEachEntry(TIntIntProcedure procedure)

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

Parameters:

procedure - a TOIntIntProcedure value

Returns:

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

retainEntries

public boolean retainEntries(TIntIntProcedure 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(TIntFunction function)

Transform the values in this map using function.

Parameters:

function - a TIntFunction value

increment

public boolean increment(int 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(int key,
                           int 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.