gnu.trove

Class TShortHashSet

Implemented Interfaces:
Externalizable

public class TShortHashSet
extends TShortHash
implements Externalizable

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

Constructor Summary

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

Method Summary

boolean
add(short val)
Inserts a value into the set.
boolean
addAll(short[] array)
Adds all of the elements in array to the set.
void
clear()
Empties the set.
boolean
containsAll(short[] 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()
TShortIterator
iterator()
void
readExternal(ObjectInput in)
protected void
rehash(int newCapacity)
Expands the set to accomodate new values.
boolean
remove(short val)
Removes val from the set.
boolean
removeAll(short[] array)
Removes all of the elements in array from the set.
boolean
retainAll(short[] array)
Removes any values in the set which are not contained in array.
short[]
toArray()
Returns a new array containing the values in the set.
void
writeExternal(ObjectOutput out)

Constructor Details

TShortHashSet

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

TShortHashSet

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

TShortHashSet

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

TShortHashSet

public TShortHashSet(int initialCapacity,
                     TShortHashingStrategy strategy)
Creates a new TShortHash 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.

TShortHashSet

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

TShortHashSet

public TShortHashSet(int initialCapacity,
                     float loadFactor,
                     TShortHashingStrategy strategy)
Creates a new TShortHash 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.

TShortHashSet

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

TShortHashSet

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

Method Details

add

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

addAll

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

clear

public void clear()
Empties the set.

containsAll

public boolean containsAll(short[] array)
Tests the set to determine if all of the elements in array are present.
Parameters:
array - an array of short 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 TShortIterator iterator()
Returns:
a TShortIterator 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(short val)
Removes val from the set.
Parameters:
val - an short value
Returns:
true if the set was modified by the remove operation.

removeAll

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

retainAll

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

toArray

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

writeExternal

public void writeExternal(ObjectOutput out)
            throws IOException

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