GNU Trove

gnu.trove
Class TObjectIntHashMap

java.lang.Object
  |
  +--gnu.trove.THash
        |
        +--gnu.trove.TObjectHash
              |
              +--gnu.trove.TObjectIntHashMap
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable, TObjectHashingStrategy

public class TObjectIntHashMap
extends TObjectHash
implements java.io.Serializable

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

Version:
$Id: TObjectIntHashMap.java,v 1.13 2003/03/23 04:06:59 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.TObjectHash
_hashingStrategy, _set, REMOVED
 
Fields inherited from class gnu.trove.THash
_free, _loadFactor, _maxSize, _size, DEFAULT_INITIAL_CAPACITY, DEFAULT_LOAD_FACTOR
 
Constructor Summary
TObjectIntHashMap()
          Creates a new TObjectIntHashMap instance with the default capacity and load factor.
TObjectIntHashMap(int initialCapacity)
          Creates a new TObjectIntHashMap instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.
TObjectIntHashMap(int initialCapacity, float loadFactor)
          Creates a new TObjectIntHashMap instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.
TObjectIntHashMap(int initialCapacity, float loadFactor, TObjectHashingStrategy strategy)
          Creates a new TObjectIntHashMap instance with a prime value at or near the specified capacity and load factor.
TObjectIntHashMap(int initialCapacity, TObjectHashingStrategy strategy)
          Creates a new TObjectIntHashMap instance whose capacity is the next highest prime above initialCapacity + 1 unless that value is already prime.
TObjectIntHashMap(TObjectHashingStrategy strategy)
          Creates a new TObjectIntHashMap instance with the default capacity and load factor.
 
Method Summary
 boolean adjustValue(java.lang.Object key, int amount)
          Adjusts the primitive value mapped to key.
 void clear()
          Empties the map.
 boolean containsKey(java.lang.Object 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(TObjectIntProcedure procedure)
          Executes procedure for each key/value entry in the map.
 boolean forEachKey(TObjectProcedure procedure)
          Executes procedure for each key in the map.
 boolean forEachValue(TIntProcedure procedure)
          Executes procedure for each value in the map.
 int get(java.lang.Object key)
          retrieves the value for key
 int[] getValues()
          Returns the values of the map.
 boolean increment(java.lang.Object key)
          Increments the primitive value mapped to key by 1
 TObjectIntIterator iterator()
           
 java.lang.Object[] keys()
          returns the keys of the map.
 int put(java.lang.Object 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(java.lang.Object key)
          Deletes a key/value pair from the map.
protected  void removeAt(int index)
          removes the mapping at index from the map.
 boolean retainEntries(TObjectIntProcedure 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.TObjectHash
capacity, clone, computeHashCode, contains, equals, forEach, index, insertionIndex, throwObjectContractViolation
 
Methods inherited from class gnu.trove.THash
compact, ensureCapacity, isEmpty, postInsertHook, size, trimToSize
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_values

protected transient int[] _values
the values of the map

Constructor Detail

TObjectIntHashMap

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


TObjectIntHashMap

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

Parameters:
initialCapacity - an int value

TObjectIntHashMap

public TObjectIntHashMap(int initialCapacity,
                         float loadFactor)
Creates a new TObjectIntHashMap 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

TObjectIntHashMap

public TObjectIntHashMap(TObjectHashingStrategy strategy)
Creates a new TObjectIntHashMap instance with the default capacity and load factor.

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

TObjectIntHashMap

public TObjectIntHashMap(int initialCapacity,
                         TObjectHashingStrategy strategy)
Creates a new TObjectIntHashMap 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.

TObjectIntHashMap

public TObjectIntHashMap(int initialCapacity,
                         float loadFactor,
                         TObjectHashingStrategy strategy)
Creates a new TObjectIntHashMap 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

iterator

public TObjectIntIterator iterator()
Returns:
an iterator over the entries in this map

setUp

protected int setUp(int initialCapacity)
initializes the hashtable to a prime capacity which is at least initialCapacity + 1.

Overrides:
setUp in class TObjectHash
Parameters:
initialCapacity - an int value
Returns:
the actual capacity chosen

put

public int put(java.lang.Object key,
               int value)
Inserts a key/value pair into the map.

Parameters:
key - an Object value
value - an int value
Returns:
the previous value associated with key, or null 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(java.lang.Object key)
retrieves the value for key

Parameters:
key - an Object value
Returns:
the value of key or null if no such mapping exists.

clear

public void clear()
Empties the map.

Overrides:
clear in class THash

remove

public int remove(java.lang.Object key)
Deletes a key/value pair from the map.

Parameters:
key - an Object value
Returns:
an int value

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

removeAt

protected void removeAt(int index)
removes the mapping at index from the map.

Overrides:
removeAt in class TObjectHash
Parameters:
index - an int value

getValues

public int[] getValues()
Returns the values of the map.

Returns:
a Collection value

keys

public java.lang.Object[] 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(java.lang.Object key)
checks for the present of key in the keys of the map.

Parameters:
key - an Object value
Returns:
a boolean value

forEachKey

public boolean forEachKey(TObjectProcedure procedure)
Executes procedure for each key in the map.

Parameters:
procedure - a TObjectProcedure 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(TObjectIntProcedure procedure)
Executes procedure for each key/value entry in the map.

Parameters:
procedure - a TOObjectIntProcedure value
Returns:
false if the loop over the entries terminated because the procedure returned false for some entry.

retainEntries

public boolean retainEntries(TObjectIntProcedure 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(java.lang.Object 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(java.lang.Object 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.

GNU Trove

GNU Trove is copyright 2001-2003 Eric D. Friedman. All Rights Reserved.