GNU Trove

gnu.trove
Class TIntLongHashMap

java.lang.Object
  |
  +--gnu.trove.THash
        |
        +--gnu.trove.TPrimitiveHash
              |
              +--gnu.trove.TIntHash
                    |
                    +--gnu.trove.TIntLongHashMap
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable, TIntHashingStrategy

public class TIntLongHashMap
extends TIntHash
implements java.io.Serializable

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

Version:
$Id: TIntLongHashMap.java,v 1.15 2003/11/21 17:32:30 ericdf Exp $
Author:
Eric D. Friedman
See Also:
Serialized Form

Field Summary
protected  long[] _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
TIntLongHashMap()
          Creates a new TIntLongHashMap instance with the default capacity and load factor.
TIntLongHashMap(int initialCapacity)
          Creates a new TIntLongHashMap instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.
TIntLongHashMap(int initialCapacity, float loadFactor)
          Creates a new TIntLongHashMap instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.
TIntLongHashMap(int initialCapacity, float loadFactor, TIntHashingStrategy strategy)
          Creates a new TIntLongHashMap instance with a prime value at or near the specified capacity and load factor.
TIntLongHashMap(int initialCapacity, TIntHashingStrategy strategy)
          Creates a new TIntLongHashMap instance whose capacity is the next highest prime above initialCapacity + 1 unless that value is already prime.
TIntLongHashMap(TIntHashingStrategy strategy)
          Creates a new TIntLongHashMap instance with the default capacity and load factor.
 
Method Summary
 boolean adjustValue(int key, long 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(long 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(TIntLongProcedure 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(TLongProcedure procedure)
          Executes procedure for each value in the map.
 long get(int key)
          retrieves the value for key
 long[] getValues()
          Returns the values of the map.
 int hashCode()
           
 boolean increment(int key)
          Increments the primitive value mapped to key by 1
 TIntLongIterator iterator()
           
 int[] keys()
          returns the keys of the map.
 long put(int key, long value)
          Inserts a key/value pair into the map.
protected  void rehash(int newCapacity)
          rehashes the map to the new capacity.
 long 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(TIntLongProcedure 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(TLongFunction 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 long[] _values
the values of the map

Constructor Detail

TIntLongHashMap

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


TIntLongHashMap

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

Parameters:
initialCapacity - an int value

TIntLongHashMap

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

TIntLongHashMap

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

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

TIntLongHashMap

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

TIntLongHashMap

public TIntLongHashMap(int initialCapacity,
                       float loadFactor,
                       TIntHashingStrategy strategy)
Creates a new TIntLongHashMap 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 TIntLongIterator iterator()
Returns:
a TIntLongIterator 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 long put(int key,
                long value)
Inserts a key/value pair into the map.

Parameters:
key - an int value
value - an long value
Returns:
the previous value associated with key, or (long)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 long get(int key)
retrieves the value for key

Parameters:
key - an int value
Returns:
the value of key or (long)0 if no such mapping exists.

clear

public void clear()
Empties the map.

Overrides:
clear in class THash

remove

public long remove(int key)
Deletes a key/value pair from the map.

Parameters:
key - an int value
Returns:
an long value, or (long)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 long[] 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(long val)
checks for the presence of val in the values of the map.

Parameters:
val - an long 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(TLongProcedure procedure)
Executes procedure for each value in the map.

Parameters:
procedure - a TLongProcedure value
Returns:
false if the loop over the values terminated because the procedure returned false for some value.

forEachEntry

public boolean forEachEntry(TIntLongProcedure procedure)
Executes procedure for each key/value entry in the map.

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

retainEntries

public boolean retainEntries(TIntLongProcedure 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(TLongFunction function)
Transform the values in this map using function.

Parameters:
function - a TLongFunction 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,
                           long 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.