openlr.collection

Class OpenLongIntHashMap

java.lang.Object

cern.colt.PersistentObject

cern.colt.map.AbstractMap

openlr.collection.OpenAbstractCollection

openlr.collection.OpenLongIntHashMap

All Implemented Interfaces:

Serializable, Cloneable

public class OpenLongIntHashMap
extends OpenAbstractCollection

Hash map holding (key,value) associations of type (long-->Object); Automatically grows and shrinks as needed; Implemented using open addressing with double hashing. First see the package summary and javadoc tree view to get the broad picture. Overrides many methods for performance reasons only.

Version:

1.0, 09/24/99

Author:

wolfgang.hoschek@cern.ch

See Also:

HashMap, Serialized Form

Field Summary

Fields inherited from class openlr.collection.OpenAbstractCollection

FREE, freeEntries, FULL, REMOVED, state, table

Fields inherited from class cern.colt.map.AbstractMap

defaultCapacity, defaultMaxLoadFactor, defaultMinLoadFactor, distinct, highWaterMark, lowWaterMark, maxLoadFactor, minLoadFactor

Constructor Summary

Constructors

Constructor and Description
OpenLongIntHashMap() Constructs an empty map with default capacity and default load factors.
OpenLongIntHashMap(int initialCapacity) Constructs an empty map with the specified initial capacity and default load factors.
OpenLongIntHashMap(int initialCapacity, double minLoadFactor, double maxLoadFactor) Constructs an empty map with the specified initial capacity and the specified minimum and maximum load factor.

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all (key,value) associations from the receiver.
Object	clone() Returns a deep copy of the receiver.
boolean	containsValue(int value) Returns true if the receiver contains the specified value.
boolean	forEachPair(LongIntProcedure procedure) Applies a procedure to each (key,value) pair of the receiver, if any.
int	get(long key) Returns the value associated with the specified key.
protected int	indexOfValue(int value)
long	keyOf(int value) Returns the first key the given value is associated with.
void	keys(LongArrayList list) Fills all keys contained in the receiver into the specified list.
void	pairsMatching(LongIntProcedure condition, LongArrayList keyList, IntArrayList valueList) Fills all pairs satisfying a given condition into the specified lists.
boolean	put(long key, int value) Associates the given key with the given value.
protected void	rehash(int newCapacity) Rehashes the contents of the receiver into a new table with a smaller or larger capacity.
boolean	removeKey(long key) Removes the given key with its associated element from the receiver, if present.
protected void	setUp(int initialCapacity, double minLoadFactor, double maxLoadFactor) Initializes the receiver.
void	values(IntArrayList list) Fills all values contained in the receiver into the specified list.

Methods inherited from class openlr.collection.OpenAbstractCollection

containsKey, ensureCapacity, forEachKey, indexOfInsertion, indexOfKey, trimToSize

Methods inherited from class cern.colt.map.AbstractMap

chooseGrowCapacity, chooseHighWaterMark, chooseLowWaterMark, chooseMeanCapacity, chooseShrinkCapacity, isEmpty, nextPrime, size

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OpenLongIntHashMap

public OpenLongIntHashMap()

Constructs an empty map with default capacity and default load factors.

OpenLongIntHashMap

public OpenLongIntHashMap(int initialCapacity)

Constructs an empty map with the specified initial capacity and default load factors.

Parameters:

initialCapacity - the initial capacity

OpenLongIntHashMap

public OpenLongIntHashMap(int initialCapacity,
                          double minLoadFactor,
                          double maxLoadFactor)

Constructs an empty map with the specified initial capacity and the specified minimum and maximum load factor.

Parameters:

initialCapacity - the initial capacity

minLoadFactor - the min load factor

maxLoadFactor - the max load factor

Method Detail

clear

public final void clear()

Removes all (key,value) associations from the receiver. Implicitly calls trimToSize().

Specified by:

clear in class AbstractMap

clone

public final Object clone()

Returns a deep copy of the receiver.

Overrides:

clone in class PersistentObject

Returns:

a deep copy of the receiver.

containsValue

public final boolean containsValue(int value)

Returns true if the receiver contains the specified value.

Parameters:

value - the value

Returns:

true if the receiver contains the specified value.

forEachPair

public final boolean forEachPair(LongIntProcedure procedure)

Applies a procedure to each (key,value) pair of the receiver, if any. Iteration order is guaranteed to be identical to the order used by method OpenAbstractCollection.forEachKey(LongProcedure).

Parameters:

procedure - the procedure to be applied. Stops iteration if the procedure returns false, otherwise continues.

Returns:

false if the procedure stopped before all keys where iterated over, true otherwise.

get

public final int get(long key)

Returns the value associated with the specified key. It is often a good idea to first check with OpenAbstractCollection.containsKey(long) whether the given key has a value associated or not, i.e. whether there exists an association for the given key or not.

Parameters:

key - the key to be searched for.

Returns:

the value associated with the specified key; null if no such key is present.

indexOfValue

protected final int indexOfValue(int value)

Parameters:

value - the value to be searched in the receiver.

Returns:

the index where the value is contained in the receiver, returns -1 if the value was not found.

keyOf

public final long keyOf(int value)

Returns the first key the given value is associated with. It is often a good idea to first check with containsValue(int) whether there exists an association from a key to this value. Search order is guaranteed to be identical to the order used by method OpenAbstractCollection.forEachKey(LongProcedure).

Parameters:

value - the value to search for.

Returns:

the first key for which holds get(key) == value; returns Long.MIN_VALUE if no such key exists.

keys

public final void keys(LongArrayList list)

Fills all keys contained in the receiver into the specified list. Fills the list, starting at index 0. After this call returns the specified list has a new size that equals this.size(). Iteration order is guaranteed to be identical to the order used by method OpenAbstractCollection.forEachKey(LongProcedure).

This method can be used to iterate over the keys of the receiver.

Parameters:

list - the list to be filled, can have any size.

pairsMatching

public final void pairsMatching(LongIntProcedure condition,
                                LongArrayList keyList,
                                IntArrayList valueList)

Fills all pairs satisfying a given condition into the specified lists. Fills into the lists, starting at index 0. After this call returns the specified lists both have a new size, the number of pairs satisfying the condition. Iteration order is guaranteed to be identical to the order used by method OpenAbstractCollection.forEachKey(LongProcedure).

Example:

 LongObjectProcedure condition = new LongObjectProcedure() { // match even keys only
        public boolean apply(long key, Object value) { return key%2==0; }
 }
 keys = (8,7,6), values = (1,2,2) --> keyList = (6,8), valueList = (2,1)
 

Parameters:

condition - the condition to be matched. Takes the current key as first and the current value as second argument.

keyList - the list to be filled with keys, can have any size.

valueList - the list to be filled with values, can have any size.

put

public final boolean put(long key,
                         int value)

Associates the given key with the given value. Replaces any old (key,someOtherValue) association, if existing.

Parameters:

key - the key the value shall be associated with.

value - the value to be associated.

Returns:

true if the receiver did not already contain such a key; false if the receiver did already contain such a key - the new value has now replaced the formerly associated value.

rehash

protected final void rehash(int newCapacity)

Rehashes the contents of the receiver into a new table with a smaller or larger capacity. This method is called automatically when the number of keys in the receiver exceeds the high water mark or falls below the low water mark.

Parameters:

newCapacity - the new capacity

removeKey

public final boolean removeKey(long key)

Removes the given key with its associated element from the receiver, if present.

Parameters:

key - the key to be removed from the receiver.

Returns:

true if the receiver contained the specified key, false otherwise.

setUp

protected final void setUp(int initialCapacity,
                           double minLoadFactor,
                           double maxLoadFactor)

Initializes the receiver.

Overrides:

setUp in class AbstractMap

Parameters:

initialCapacity - the initial capacity of the receiver.

minLoadFactor - the minLoadFactor of the receiver.

maxLoadFactor - the maxLoadFactor of the receiver.

values

public final void values(IntArrayList list)

Fills all values contained in the receiver into the specified list. Fills the list, starting at index 0. After this call returns the specified list has a new size that equals this.size(). Iteration order is guaranteed to be identical to the order used by method OpenAbstractCollection.forEachKey(LongProcedure).

This method can be used to iterate over the values of the receiver.

Parameters:

list - the list to be filled, can have any size.