gnu.trove.map.hash
Class TLongLongHashMap

java.lang.Object
  gnu.trove.impl.hash.THash
      gnu.trove.impl.hash.TPrimitiveHash
          gnu.trove.impl.hash.TLongLongHash
              gnu.trove.map.hash.TLongLongHashMap

All Implemented Interfaces:

TLongLongMap, java.io.Externalizable, java.io.Serializable

public class TLongLongHashMap
extends TLongLongHash
implements TLongLongMap, java.io.Externalizable

An open addressed Map implementation for long keys and long 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	TLongLongHashMap.TKeyView a view onto the keys of the map.
protected class	TLongLongHashMap.TValueView a view onto the values of the map.

Field Summary

protected long[]

_values the values of the map

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

_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

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

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

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

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

TLongLongHashMap(long[] keys, long[] values)
Creates a new TLongLongHashMap instance containing all of the entries in the map passed in.

TLongLongHashMap(TLongLongMap map)
Creates a new TLongLongHashMap instance containing all of the entries in the map passed in.

Method Summary

long	adjustOrPutValue(long key, long adjust_amount, long put_amount) Adjusts the primitive value mapped to the key if the key is present in the map.
boolean	adjustValue(long key, long amount) Adjusts the primitive value mapped to key.
void	clear() Empties the collection.
boolean	containsKey(long 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)
boolean	forEachEntry(TLongLongProcedure procedure) Executes procedure for each key/value entry in the map.
boolean	forEachKey(TLongProcedure procedure) Executes procedure for each key in the map.
boolean	forEachValue(TLongProcedure procedure) Executes procedure for each value in the map.
long	get(long key) Retrieves the value for key
int	hashCode()
boolean	increment(long key) Increments the primitive value mapped to key by 1
boolean	isEmpty() Tells whether this set is currently holding any elements.
TLongLongIterator	iterator()
long[]	keys() Returns the keys of the map as an array of long values.
long[]	keys(long[] aArray) Returns the keys of the map.
TLongSet	keySet() Returns the keys of the map as a TLongSet
long	put(long key, long value) Inserts a key/value pair into the map.
void	putAll(java.util.Map<? extends java.lang.Long,? extends java.lang.Long> map) Put all the entries from the given Map into this map.
void	putAll(TLongLongMap map) Put all the entries from the given map into this map.
long	putIfAbsent(long key, long 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.
long	remove(long key) Deletes a key/value pair from the map.
protected void	removeAt(int index) Releases the element currently stored at index.
boolean	retainEntries(TLongLongProcedure 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(TLongFunction function) Transform the values in this map using function.
TLongCollection	valueCollection() Returns the values of the map as a TLongCollection
long[]	values() Returns the values of the map as an array of #e# values.
long[]	values(long[] 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.TLongLongHash

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.TLongLongMap

getNoEntryKey, getNoEntryValue, size

Field Detail

_values

protected transient long[] _values

the values of the map

Constructor Detail

TLongLongHashMap

public TLongLongHashMap()

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

TLongLongHashMap

public TLongLongHashMap(int initialCapacity)

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

Parameters:

initialCapacity - an int value

TLongLongHashMap

public TLongLongHashMap(int initialCapacity,
                        float loadFactor)

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

TLongLongHashMap

public TLongLongHashMap(int initialCapacity,
                        float loadFactor,
                        long noEntryKey,
                        long noEntryValue)

Creates a new TLongLongHashMap 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 long value that represents null for the Key set.

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

TLongLongHashMap

public TLongLongHashMap(long[] keys,
                        long[] values)

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

Parameters:

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

values - a long array containing the values.

TLongLongHashMap

public TLongLongHashMap(TLongLongMap map)

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

Parameters:

map - a TLongLongMap that will be duplicated.

Method Detail

adjustOrPutValue

public long adjustOrPutValue(long key,
                             long adjust_amount,
                             long 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 TLongLongMap

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(long key,
                           long amount)

Adjusts the primitive value mapped to key.

Specified by:

adjustValue in interface TLongLongMap

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 TLongLongMap

Overrides:

clear in class THash

containsKey

public boolean containsKey(long key)

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

Specified by:

containsKey in interface TLongLongMap

Parameters:

key - an long value

Returns:

a boolean value

containsValue

public boolean containsValue(long val)

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

Specified by:

containsValue in interface TLongLongMap

Parameters:

val - an long value

Returns:

a boolean value

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

forEachEntry

public boolean forEachEntry(TLongLongProcedure procedure)

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

Specified by:

forEachEntry in interface TLongLongMap

Parameters:

procedure - a TOLongLongProcedure value

Returns:

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

forEachKey

public boolean forEachKey(TLongProcedure procedure)

Executes procedure for each key in the map.

Specified by:

forEachKey in interface TLongLongMap

Parameters:

procedure - a TLongProcedure 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.

Specified by:

forEachValue in interface TLongLongMap

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 long get(long key)

Retrieves the value for key

Specified by:

get in interface TLongLongMap

Parameters:

key - an long value

Returns:

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

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

increment

public boolean increment(long key)

Increments the primitive value mapped to key by 1

Specified by:

increment in interface TLongLongMap

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 TLongLongMap

Overrides:

isEmpty in class THash

Returns:

a boolean value

iterator

public TLongLongIterator iterator()

Specified by:

iterator in interface TLongLongMap

Returns:

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

keys

public long[] keys()

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

Specified by:

keys in interface TLongLongMap

Returns:

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

keys

public long[] keys(long[] aArray)

Returns the keys of the map.

Specified by:

keys in interface TLongLongMap

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 TLongSet keySet()

Returns the keys of the map as a TLongSet

Specified by:

keySet in interface TLongLongMap

Returns:

the keys of the map as a TLongSet

put

public long put(long key,
                long value)

Inserts a key/value pair into the map.

Specified by:

put in interface TLongLongMap

Parameters:

key - an long value

value - an long value

Returns:

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

putAll

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

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

Specified by:

putAll in interface TLongLongMap

Parameters:

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

putAll

public void putAll(TLongLongMap map)

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

Specified by:

putAll in interface TLongLongMap

Parameters:

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

putIfAbsent

public long putIfAbsent(long key,
                        long 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 TLongLongMap

Parameters:

key - an long value

value - an long value

Returns:

the previous value associated with key, or the "no entry" value if none was found (see TLongLongMap.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 TLongLongHash

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 long remove(long key)

Deletes a key/value pair from the map.

Specified by:

remove in interface TLongLongMap

Parameters:

key - an long value

Returns:

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

removeAt

protected void removeAt(int index)

Releases the element currently stored at index.

Overrides:

removeAt in class TLongLongHash

Parameters:

index - an int value

retainEntries

public boolean retainEntries(TLongLongProcedure procedure)

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

Specified by:

retainEntries in interface TLongLongMap

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 TLongLongHash

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(TLongFunction function)

Transform the values in this map using function.

Specified by:

transformValues in interface TLongLongMap

Parameters:

function - a TLongFunction value

valueCollection

public TLongCollection valueCollection()

Returns the values of the map as a TLongCollection

Specified by:

valueCollection in interface TLongLongMap

Returns:

the values of the map as a TLongCollection

values

public long[] values()

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

Specified by:

values in interface TLongLongMap

Returns:

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

values

public long[] values(long[] aArray)

Returns the values of the map using an existing array.

Specified by:

values in interface TLongLongMap

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 TLongLongHash

Throws:

java.io.IOException