openlr.collection

Class OpenLongHashSet

java.lang.Object

cern.colt.PersistentObject

cern.colt.map.AbstractMap

openlr.collection.OpenAbstractCollection

openlr.collection.OpenLongHashSet

All Implemented Interfaces:

Serializable, Cloneable

public class OpenLongHashSet
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.

Author:

wolfgang.hoschek@cern.ch, TomTom International B.V.

See Also:

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
OpenLongHashSet() Constructs an empty map with default capacity and default load factors.
OpenLongHashSet(int initialCapacity) Constructs an empty map with the specified initial capacity and default load factors.
OpenLongHashSet(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.
void	keys(LongArrayList list) Fills all keys contained in the receiver into the specified list.
boolean	put(long key) 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.

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

OpenLongHashSet

public OpenLongHashSet()

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

OpenLongHashSet

public OpenLongHashSet(int initialCapacity)

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

Parameters:

initialCapacity - the initial capacity of the map.

OpenLongHashSet

public OpenLongHashSet(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 minimum load factor.

maxLoadFactor - the maximum 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.

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.

put

public final boolean put(long key)

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.

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.