gnu.trove.map.hash
Class TIntIntHashMap

java.lang.Object
  gnu.trove.impl.hash.THash
      gnu.trove.impl.hash.TPrimitiveHash
          gnu.trove.impl.hash.TIntIntHash
              gnu.trove.map.hash.TIntIntHashMap

All Implemented Interfaces:

TIntIntMap, java.io.Externalizable, java.io.Serializable

public class TIntIntHashMap
extends TIntIntHash
implements TIntIntMap, java.io.Externalizable

An open addressed Map implementation for int keys and int values.

Version:

$Id: _K__V_HashMap.template,v 1.1.2.13 2009/11/16 21:25:13 robeden Exp $

Author:

Eric D. Friedman, Rob Eden, Jeff Randall

See Also:

Serialized Form

Nested Class Summary

protected class	TIntIntHashMap.TKeyView a view onto the keys of the map.
protected class	TIntIntHashMap.TValueView a view onto the values of the map.

Field Summary

protected int[]

_values the values of the map

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

_set, no_entry_key, no_entry_value

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

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[] keys, int[] values)
Creates a new TIntIntHashMap instance containing all of the entries in the map passed in.

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, int noEntryKey, int noEntryValue)
Creates a new TIntIntHashMap instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.

TIntIntHashMap(TIntIntMap map)
Creates a new TIntIntHashMap instance containing all of the entries in the map passed in.

Method Summary

int	adjustOrPutValue(int key, int adjust_amount, int put_amount) Adjusts the primitive value mapped to the key if the key is present in the map.
boolean	adjustValue(int key, int amount) Adjusts the primitive value mapped to key.
void	clear() Empties the collection.
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)
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	hashCode()
boolean	increment(int key) Increments the primitive value mapped to key by 1
boolean	isEmpty() Tells whether this set is currently holding any elements.
TIntIntIterator	iterator()
int[]	keys() Returns the keys of the map as an array of int values.
int[]	keys(int[] aArray) Returns the keys of the map.
TIntSet	keySet() Returns the keys of the map as a TIntSet
int	put(int key, int value) Inserts a key/value pair into the map.
void	putAll(java.util.Map<? extends java.lang.Integer,? extends java.lang.Integer> map) Put all the entries from the given Map into this map.
void	putAll(TIntIntMap map) Put all the entries from the given map into this map.
int	putIfAbsent(int key, int value) Inserts a key/value pair into the map if the specified key is not already associated with a value.
void	readExternal(java.io.ObjectInput in)
protected void	rehash(int newCapacity) Rehashes the set.
int	remove(int key) Deletes a key/value pair from the map.
protected void	removeAt(int index) Releases the element currently stored at index.
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.
java.lang.String	toString()
void	transformValues(TIntFunction function) Transform the values in this map using function.
TIntCollection	valueCollection() Returns the values of the map as a TIntCollection
int[]	values() Returns the values of the map as an array of #e# values.
int[]	values(int[] aArray) Returns the values of the map using an existing array.
void	writeExternal(java.io.ObjectOutput out)

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

contains, forEach, getNoEntryKey, getNoEntryValue, index, insertionIndex

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

capacity

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

calculateGrownCapacity, compact, computeMaxSize, computeNextAutoCompactionAmount, ensureCapacity, getAutoCompactionFactor, postInsertHook, reenableAutoCompaction, setAutoCompactionFactor, size, tempDisableAutoCompaction, trimToSize

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface gnu.trove.map.TIntIntMap

getNoEntryKey, getNoEntryValue, size

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(int initialCapacity,
                      float loadFactor,
                      int noEntryKey,
                      int noEntryValue)

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

noEntryKey - a int value that represents null for the Key set.

noEntryValue - a int value that represents null for the Value set.

TIntIntHashMap

public TIntIntHashMap(int[] keys,
                      int[] values)

Creates a new TIntIntHashMap instance containing all of the entries in the map passed in.

Parameters:

keys - a int array containing the keys for the matching values.

values - a int array containing the values.

TIntIntHashMap

public TIntIntHashMap(TIntIntMap map)

Creates a new TIntIntHashMap instance containing all of the entries in the map passed in.

Parameters:

map - a TIntIntMap that will be duplicated.

Method Detail

adjustOrPutValue

public int adjustOrPutValue(int key,
                            int adjust_amount,
                            int 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.

Specified by:

adjustOrPutValue in interface TIntIntMap

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

adjustValue

public boolean adjustValue(int key,
                           int amount)

Adjusts the primitive value mapped to key.

Specified by:

adjustValue in interface TIntIntMap

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.

clear

public void clear()

Empties the collection.

Specified by:

clear in interface TIntIntMap

Overrides:

clear in class THash

containsKey

public boolean containsKey(int key)

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

Specified by:

containsKey in interface TIntIntMap

Parameters:

key - an int value

Returns:

a boolean value

containsValue

public boolean containsValue(int val)

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

Specified by:

containsValue in interface TIntIntMap

Parameters:

val - an int value

Returns:

a boolean value

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

forEachEntry

public boolean forEachEntry(TIntIntProcedure procedure)

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

Specified by:

forEachEntry in interface TIntIntMap

Parameters:

procedure - a TOIntIntProcedure value

Returns:

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

forEachKey

public boolean forEachKey(TIntProcedure procedure)

Executes procedure for each key in the map.

Specified by:

forEachKey in interface TIntIntMap

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.

Specified by:

forEachValue in interface TIntIntMap

Parameters:

procedure - a T#F#Procedure value

Returns:

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

get

public int get(int key)

Retrieves the value for key

Specified by:

get in interface TIntIntMap

Parameters:

key - an int value

Returns:

the previous value associated with key, or the "no entry" value if none was found (see TIntIntMap.getNoEntryValue()).

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

increment

public boolean increment(int key)

Increments the primitive value mapped to key by 1

Specified by:

increment in interface TIntIntMap

Parameters:

key - the key of the value to increment

Returns:

true if a mapping was found and modified.

isEmpty

public boolean isEmpty()

Tells whether this set is currently holding any elements.

Specified by:

isEmpty in interface TIntIntMap

Overrides:

isEmpty in class THash

Returns:

a boolean value

iterator

public TIntIntIterator iterator()

Specified by:

iterator in interface TIntIntMap

Returns:

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

keys

public int[] keys()

Returns the keys of the map as an array of int values.

Specified by:

keys in interface TIntIntMap

Returns:

the keys of the map as an array of int values.

keys

public int[] keys(int[] aArray)

Returns the keys of the map.

Specified by:

keys in interface TIntIntMap

Parameters:

aArray - 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:

the keys of the map as an array.

keySet

public TIntSet keySet()

Returns the keys of the map as a TIntSet

Specified by:

keySet in interface TIntIntMap

Returns:

the keys of the map as a TIntSet

put

public int put(int key,
               int value)

Inserts a key/value pair into the map.

Specified by:

put in interface TIntIntMap

Parameters:

key - an int value

value - an int value

Returns:

the previous value associated with key, or the "no entry" value if none was found (see TIntIntMap.getNoEntryValue()).

putAll

public void putAll(java.util.Map<? extends java.lang.Integer,? extends java.lang.Integer> map)

Put all the entries from the given Map into this map.

Specified by:

putAll in interface TIntIntMap

Parameters:

map - The Map from which entries will be obtained to put into this map.

putAll

public void putAll(TIntIntMap map)

Put all the entries from the given map into this map.

Specified by:

putAll in interface TIntIntMap

Parameters:

map - The map from which entries will be obtained to put into this map.

putIfAbsent

public int putIfAbsent(int key,
                       int value)

Inserts a key/value pair into the map if the specified key is not already associated with a value.

Specified by:

putIfAbsent in interface TIntIntMap

Parameters:

key - an int value

value - an int value

Returns:

the previous value associated with key, or the "no entry" value if none was found (see TIntIntMap.getNoEntryValue()).

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 TIntIntHash

Throws:

java.io.IOException

java.lang.ClassNotFoundException

rehash

protected void rehash(int newCapacity)

Rehashes the set.

Specified by:

rehash in class THash

Parameters:

newCapacity - an int value

remove

public int remove(int key)

Deletes a key/value pair from the map.

Specified by:

remove in interface TIntIntMap

Parameters:

key - an int value

Returns:

the previous value associated with key, or the "no entry" value if none was found (see TIntIntMap.getNoEntryValue()).

removeAt

protected void removeAt(int index)

Releases the element currently stored at index.

Overrides:

removeAt in class TIntIntHash

Parameters:

index - an int value

retainEntries

public boolean retainEntries(TIntIntProcedure procedure)

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

Specified by:

retainEntries in interface TIntIntMap

Parameters:

procedure - determines which entries to keep

Returns:

true if the map was modified.

setUp

protected int setUp(int initialCapacity)

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

Overrides:

setUp in class TIntIntHash

Parameters:

initialCapacity - an int value

Returns:

the actual capacity chosen

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

transformValues

public void transformValues(TIntFunction function)

Transform the values in this map using function.

Specified by:

transformValues in interface TIntIntMap

Parameters:

function - a TIntFunction value

valueCollection

public TIntCollection valueCollection()

Returns the values of the map as a TIntCollection

Specified by:

valueCollection in interface TIntIntMap

Returns:

the values of the map as a TIntCollection

values

public int[] values()

Returns the values of the map as an array of #e# values.

Specified by:

values in interface TIntIntMap

Returns:

the values of the map as an array of #e# values.

values

public int[] values(int[] aArray)

Returns the values of the map using an existing array.

Specified by:

values in interface TIntIntMap

Parameters:

aArray - 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:

the values of the map as an array of #e# values.

writeExternal

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

Specified by:

writeExternal in interface java.io.Externalizable

Overrides:

writeExternal in class TIntIntHash

Throws:

java.io.IOException