PCJ API
Version 1.2

bak.pcj.set
Class LongChainedHashSet

java.lang.Object
  extended bybak.pcj.AbstractLongCollection
      extended bybak.pcj.set.AbstractLongSet
          extended bybak.pcj.set.LongChainedHashSet
All Implemented Interfaces:
Cloneable, LongCollection, LongSet, Serializable

public class LongChainedHashSet
extends AbstractLongSet
implements LongSet, Cloneable, Serializable

This class represents chained hash table based sets of long values. Unlike the Java Collections HashSet instances of this class are not backed up by a map. It is implemented using a simple chained hash table where the keys are stored directly as entries.

Since:
1.0
See Also:
LongOpenHashSet, HashSet, Serialized Form

Field Summary
static int DEFAULT_CAPACITY
          The default capacity of this set.
static int DEFAULT_GROWTH_CHUNK
          The default chunk size with which to increase the capacity of this set.
static double DEFAULT_GROWTH_FACTOR
          The default factor with which to increase the capacity of this set.
static double DEFAULT_LOAD_FACTOR
          The default load factor of this set.
 
Constructor Summary
LongChainedHashSet()
          Creates a new hash set with capacity 11, a relative growth factor of 1.0, and a load factor of 75%.
LongChainedHashSet(double loadFactor)
          Creates a new hash set with a capacity of 11, a relative growth factor of 1.0, and a specified load factor.
LongChainedHashSet(int capacity)
          Creates a new hash set with a specified capacity, a relative growth factor of 1.0, and a load factor of 75%.
LongChainedHashSet(int capacity, double loadFactor)
          Creates a new hash set with a specified capacity and load factor, and a relative growth factor of 1.0.
LongChainedHashSet(int capacity, double loadFactor, double growthFactor)
          Creates a new hash set with a specified capacity, load factor, and relative growth factor.
LongChainedHashSet(int capacity, double loadFactor, int growthChunk)
          Creates a new hash set with a specified capacity, load factor, and absolute growth factor.
LongChainedHashSet(long[] a)
          Creates a new hash set with the same elements as the specified array.
LongChainedHashSet(LongCollection c)
          Creates a new hash set with the same elements as a specified collection.
LongChainedHashSet(LongHashFunction keyhash)
          Creates a new hash set with capacity 11, a relative growth factor of 1.0, and a load factor of 75%.
LongChainedHashSet(LongHashFunction keyhash, double loadFactor)
          Creates a new hash set with a capacity of 11, a relative growth factor of 1.0, and a specified load factor.
LongChainedHashSet(LongHashFunction keyhash, int capacity)
          Creates a new hash set with a specified capacity, a relative growth factor of 1.0, and a load factor of 75%.
LongChainedHashSet(LongHashFunction keyhash, int capacity, double loadFactor)
          Creates a new hash set with a specified capacity and load factor, and a relative growth factor of 1.0.
LongChainedHashSet(LongHashFunction keyhash, int capacity, double loadFactor, double growthFactor)
          Creates a new hash set with a specified capacity, load factor, and relative growth factor.
LongChainedHashSet(LongHashFunction keyhash, int capacity, double loadFactor, int growthChunk)
          Creates a new hash set with a specified capacity, load factor, and absolute growth factor.
 
Method Summary
 boolean add(long v)
          Adds an element to this collection.
 void clear()
          Clears this collection.
 Object clone()
          Returns a clone of this hash set.
 boolean contains(long v)
          Indicates whether this collection contains a specified element.
 int hashCode()
          Returns a hash code value for this collection.
 LongIterator iterator()
          Returns an iterator over this collection.
 boolean remove(long v)
          Removes a specified element from this collection.
 int size()
          Returns the number of elements in this collection.
 long[] toArray(long[] a)
          Returns the elements of this collection as an array.
 void trimToSize()
          Minimizes the memory used by this collection.
 
Methods inherited from class bak.pcj.set.AbstractLongSet
equals
 
Methods inherited from class bak.pcj.AbstractLongCollection
addAll, containsAll, isEmpty, removeAll, retainAll, toArray, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface bak.pcj.LongCollection
addAll, containsAll, equals, isEmpty, removeAll, retainAll, toArray
 

Field Detail

DEFAULT_GROWTH_FACTOR

public static final double DEFAULT_GROWTH_FACTOR
The default factor with which to increase the capacity of this set.

See Also:
Constant Field Values

DEFAULT_GROWTH_CHUNK

public static final int DEFAULT_GROWTH_CHUNK
The default chunk size with which to increase the capacity of this set.

See Also:
Constant Field Values

DEFAULT_CAPACITY

public static final int DEFAULT_CAPACITY
The default capacity of this set.

See Also:
Constant Field Values

DEFAULT_LOAD_FACTOR

public static final double DEFAULT_LOAD_FACTOR
The default load factor of this set.

See Also:
Constant Field Values
Constructor Detail

LongChainedHashSet

public LongChainedHashSet()
Creates a new hash set with capacity 11, a relative growth factor of 1.0, and a load factor of 75%.


LongChainedHashSet

public LongChainedHashSet(LongCollection c)
Creates a new hash set with the same elements as a specified collection.

Parameters:
c - the collection whose elements to add to the new set.
Throws:
NullPointerException - if c is null.

LongChainedHashSet

public LongChainedHashSet(long[] a)
Creates a new hash set with the same elements as the specified array.

Parameters:
a - the array whose elements to add to the new set.
Throws:
NullPointerException - if a is null.
Since:
1.1

LongChainedHashSet

public LongChainedHashSet(int capacity)
Creates a new hash set with a specified capacity, a relative growth factor of 1.0, and a load factor of 75%.

Parameters:
capacity - the initial capacity of the set.
Throws:
IllegalArgumentException - if capacity is negative.

LongChainedHashSet

public LongChainedHashSet(double loadFactor)
Creates a new hash set with a capacity of 11, a relative growth factor of 1.0, and a specified load factor.

Parameters:
loadFactor - the load factor of the set.
Throws:
IllegalArgumentException - if loadFactor is negative.

LongChainedHashSet

public LongChainedHashSet(int capacity,
                          double loadFactor)
Creates a new hash set with a specified capacity and load factor, and a relative growth factor of 1.0.

Parameters:
capacity - the initial capacity of the set.
loadFactor - the load factor of the set.
Throws:
IllegalArgumentException - if capacity is negative; if loadFactor is not positive.

LongChainedHashSet

public LongChainedHashSet(int capacity,
                          double loadFactor,
                          double growthFactor)
Creates a new hash set with a specified capacity, load factor, and relative growth factor.

The set capacity increases to capacity()*(1+growthFactor). This strategy is good for avoiding many capacity increases, but the amount of wasted memory is approximately the size of the set.

Parameters:
capacity - the initial capacity of the set.
loadFactor - the load factor of the set.
growthFactor - the relative amount with which to increase the the capacity when a capacity increase is needed.
Throws:
IllegalArgumentException - if capacity is negative; if loadFactor is not positive; if growthFactor is not positive.

LongChainedHashSet

public LongChainedHashSet(int capacity,
                          double loadFactor,
                          int growthChunk)
Creates a new hash set with a specified capacity, load factor, and absolute growth factor.

The set capacity increases to capacity()+growthChunk. This strategy is good for avoiding wasting memory. However, an overhead is potentially introduced by frequent capacity increases.

Parameters:
capacity - the initial capacity of the set.
loadFactor - the load factor of the set.
growthChunk - the absolute amount with which to increase the the capacity when a capacity increase is needed.
Throws:
IllegalArgumentException - if capacity is negative; if loadFactor is not positive; if growthChunk is not positive.

LongChainedHashSet

public LongChainedHashSet(LongHashFunction keyhash)
Creates a new hash set with capacity 11, a relative growth factor of 1.0, and a load factor of 75%.

Parameters:
keyhash - the hash function to use when hashing keys.
Throws:
NullPointerException - if keyhash is null.

LongChainedHashSet

public LongChainedHashSet(LongHashFunction keyhash,
                          int capacity)
Creates a new hash set with a specified capacity, a relative growth factor of 1.0, and a load factor of 75%.

Parameters:
keyhash - the hash function to use when hashing keys.
capacity - the initial capacity of the set.
Throws:
IllegalArgumentException - if capacity is negative.
NullPointerException - if keyhash is null.

LongChainedHashSet

public LongChainedHashSet(LongHashFunction keyhash,
                          double loadFactor)
Creates a new hash set with a capacity of 11, a relative growth factor of 1.0, and a specified load factor.

Parameters:
keyhash - the hash function to use when hashing keys.
loadFactor - the load factor of the set.
Throws:
IllegalArgumentException - if loadFactor is negative.
NullPointerException - if keyhash is null.

LongChainedHashSet

public LongChainedHashSet(LongHashFunction keyhash,
                          int capacity,
                          double loadFactor)
Creates a new hash set with a specified capacity and load factor, and a relative growth factor of 1.0.

Parameters:
keyhash - the hash function to use when hashing keys.
capacity - the initial capacity of the set.
loadFactor - the load factor of the set.
Throws:
IllegalArgumentException - if capacity is negative; if loadFactor is not positive.
NullPointerException - if keyhash is null.

LongChainedHashSet

public LongChainedHashSet(LongHashFunction keyhash,
                          int capacity,
                          double loadFactor,
                          double growthFactor)
Creates a new hash set with a specified capacity, load factor, and relative growth factor.

The set capacity increases to capacity()*(1+growthFactor). This strategy is good for avoiding many capacity increases, but the amount of wasted memory is approximately the size of the set.

Parameters:
keyhash - the hash function to use when hashing keys.
capacity - the initial capacity of the set.
loadFactor - the load factor of the set.
growthFactor - the relative amount with which to increase the the capacity when a capacity increase is needed.
Throws:
IllegalArgumentException - if capacity is negative; if loadFactor is not positive; if growthFactor is not positive.
NullPointerException - if keyhash is null.

LongChainedHashSet

public LongChainedHashSet(LongHashFunction keyhash,
                          int capacity,
                          double loadFactor,
                          int growthChunk)
Creates a new hash set with a specified capacity, load factor, and absolute growth factor.

The set capacity increases to capacity()+growthChunk. This strategy is good for avoiding wasting memory. However, an overhead is potentially introduced by frequent capacity increases.

Parameters:
keyhash - the hash function to use when hashing keys.
capacity - the initial capacity of the set.
loadFactor - the load factor of the set.
growthChunk - the absolute amount with which to increase the the capacity when a capacity increase is needed.
Throws:
IllegalArgumentException - if capacity is negative; if loadFactor is not positive; if growthChunk is not positive.
NullPointerException - if keyhash is null.
Method Detail

add

public boolean add(long v)
Description copied from interface: LongCollection
Adds an element to this collection.

Specified by:
add in interface LongCollection
Overrides:
add in class AbstractLongCollection

iterator

public LongIterator iterator()
Description copied from interface: LongCollection
Returns an iterator over this collection.

Specified by:
iterator in interface LongCollection
Returns:
an iterator over this collection.

trimToSize

public void trimToSize()
Description copied from interface: LongCollection
Minimizes the memory used by this collection. The exact operation of this method depends on the class implementing it. Implementors may choose to ignore it completely.

Specified by:
trimToSize in interface LongCollection
Overrides:
trimToSize in class AbstractLongCollection

clone

public Object clone()
Returns a clone of this hash set.

Returns:
a clone of this hash set.
Since:
1.1

size

public int size()
Description copied from interface: LongCollection
Returns the number of elements in this collection.

Specified by:
size in interface LongCollection
Overrides:
size in class AbstractLongCollection

clear

public void clear()
Description copied from interface: LongCollection
Clears this collection.

Specified by:
clear in interface LongCollection
Overrides:
clear in class AbstractLongCollection

contains

public boolean contains(long v)
Description copied from interface: LongCollection
Indicates whether this collection contains a specified element.

Specified by:
contains in interface LongCollection
Overrides:
contains in class AbstractLongCollection

hashCode

public int hashCode()
Description copied from interface: LongCollection
Returns a hash code value for this collection.

Specified by:
hashCode in interface LongCollection
Overrides:
hashCode in class AbstractLongSet

remove

public boolean remove(long v)
Description copied from interface: LongCollection
Removes a specified element from this collection.

Specified by:
remove in interface LongCollection
Overrides:
remove in class AbstractLongCollection

toArray

public long[] toArray(long[] a)
Description copied from interface: LongCollection
Returns the elements of this collection as an array.

Specified by:
toArray in interface LongCollection
Overrides:
toArray in class AbstractLongCollection

PCJ API
Version 1.2

Report a bug or request a feature.
Further information on the development and latest release of PCJ can be found at the project homepage.

Primitive Collections for Java is released under the GNU Lesser General Public License.
Copyright © 2002, 2003 Søren Bak. All Rights Reserved.

Hosted by SourceForge.net
SourceForge.net Logo