gnu.trove

Class TLongHashSet

Implemented Interfaces:
Externalizable

public class TLongHashSet
extends TLongHash
implements Externalizable

An open addressed set implementation for long primitives.
Authors:
Eric D. Friedman
Rob Eden

Constructor Summary

TLongHashSet()
Creates a new TLongHashSet instance with the default capacity and load factor.
TLongHashSet(TLongHashingStrategy strategy)
Creates a new TLongHash instance with the default capacity and load factor.
TLongHashSet(int initialCapacity)
Creates a new TLongHashSet instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.
TLongHashSet(int initialCapacity, TLongHashingStrategy strategy)
Creates a new TLongHash instance whose capacity is the next highest prime above initialCapacity + 1 unless that value is already prime.
TLongHashSet(int initialCapacity, float loadFactor)
Creates a new TLongHashSet instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.
TLongHashSet(int initialCapacity, float loadFactor, TLongHashingStrategy strategy)
Creates a new TLongHash instance with a prime value at or near the specified capacity and load factor.
TLongHashSet(long[] array)
Creates a new TLongHashSet instance containing the elements of array.
TLongHashSet(long[] array, TLongHashingStrategy strategy)
Creates a new TLongHashSet instance containing the elements of array.

Method Summary

boolean
add(long val)
Inserts a value into the set.
boolean
addAll(long[] array)
Adds all of the elements in array to the set.
void
clear()
Empties the set.
boolean
containsAll(long[] array)
Tests the set to determine if all of the elements in array are present.
boolean
equals(Object other)
Compares this set with another set for equality of their stored entries.
int
hashCode()
TLongIterator
iterator()
void
readExternal(ObjectInput in)
protected void
rehash(int newCapacity)
Expands the set to accomodate new values.
boolean
remove(long val)
Removes val from the set.
boolean
removeAll(long[] array)
Removes all of the elements in array from the set.
boolean
retainAll(long[] array)
Removes any values in the set which are not contained in array.
long[]
toArray()
Returns a new array containing the values in the set.
void
writeExternal(ObjectOutput out)

Constructor Details

TLongHashSet

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

TLongHashSet

public TLongHashSet(TLongHashingStrategy strategy)
Creates a new TLongHash instance with the default capacity and load factor.
Parameters:
strategy - used to compute hash codes and to compare keys.

TLongHashSet

public TLongHashSet(int initialCapacity)
Creates a new TLongHashSet instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.
Parameters:
initialCapacity - an int value

TLongHashSet

public TLongHashSet(int initialCapacity,
                    TLongHashingStrategy strategy)
Creates a new TLongHash 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.

TLongHashSet

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

TLongHashSet

public TLongHashSet(int initialCapacity,
                    float loadFactor,
                    TLongHashingStrategy strategy)
Creates a new TLongHash 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.

TLongHashSet

public TLongHashSet(long[] array)
Creates a new TLongHashSet instance containing the elements of array.
Parameters:
array - an array of long primitives

TLongHashSet

public TLongHashSet(long[] array,
                    TLongHashingStrategy strategy)
Creates a new TLongHashSet instance containing the elements of array.
Parameters:
array - an array of long primitives
strategy - used to compute hash codes and to compare keys.

Method Details

add

public boolean add(long val)
Inserts a value into the set.
Parameters:
val - an long value
Returns:
true if the set was modified by the add operation

addAll

public boolean addAll(long[] array)
Adds all of the elements in array to the set.
Parameters:
array - an array of long primitives.
Returns:
true if the set was modified by the add all operation.

clear

public void clear()
Empties the set.

containsAll

public boolean containsAll(long[] array)
Tests the set to determine if all of the elements in array are present.
Parameters:
array - an array of long primitives.
Returns:
true if all elements were present in the set.

equals

public boolean equals(Object other)
Compares this set with another set for equality of their stored entries.
Parameters:
other - an Object value
Returns:
a boolean value

hashCode

public int hashCode()

iterator

public TLongIterator iterator()
Returns:
a TLongIterator with access to the values in this set

readExternal

public void readExternal(ObjectInput in)
            throws IOException,
                   ClassNotFoundException

rehash

protected void rehash(int newCapacity)
Expands the set to accomodate new values.
Parameters:
newCapacity - an int value

remove

public boolean remove(long val)
Removes val from the set.
Parameters:
val - an long value
Returns:
true if the set was modified by the remove operation.

removeAll

public boolean removeAll(long[] array)
Removes all of the elements in array from the set.
Parameters:
array - an array of long primitives.
Returns:
true if the set was modified by the remove all operation.

retainAll

public boolean retainAll(long[] array)
Removes any values in the set which are not contained in array.
Parameters:
array - an array of long primitives.
Returns:
true if the set was modified by the retain all operation

toArray

public long[] toArray()
Returns a new array containing the values in the set.
Returns:
an long[] value

writeExternal

public void writeExternal(ObjectOutput out)
            throws IOException

GNU Trove is copyright B) 2001-2007 Eric D. Friedman. All Rights Reserved.