bak.pcj.set
Class DoubleChainedHashSet

java.lang.Object
  bak.pcj.AbstractDoubleCollection
      bak.pcj.set.AbstractDoubleSet
          bak.pcj.set.DoubleChainedHashSet

All Implemented Interfaces:

Cloneable, DoubleCollection, DoubleSet, Serializable

public class DoubleChainedHashSet

extends AbstractDoubleSet

implements DoubleSet, Cloneable, Serializable

This class represents chained hash table based sets of double 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:

DoubleOpenHashSet, 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

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

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

DoubleChainedHashSet(double[] a)
Creates a new hash set with the same elements as the specified array.

DoubleChainedHashSet(DoubleCollection c)
Creates a new hash set with the same elements as a specified collection.

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

DoubleChainedHashSet(DoubleHashFunction 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.

DoubleChainedHashSet(DoubleHashFunction 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%.

DoubleChainedHashSet(DoubleHashFunction 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.

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

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

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

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

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

DoubleChainedHashSet(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(double v) Adds an element to this collection.
void	clear() Clears this collection.
Object	clone() Returns a clone of this hash set.
boolean	contains(double v) Indicates whether this collection contains a specified element.
int	hashCode() Returns a hash code value for this collection.
DoubleIterator	iterator() Returns an iterator over this collection.
boolean	remove(double v) Removes a specified element from this collection.
int	size() Returns the number of elements in this collection.
double[]	toArray(double[] 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.AbstractDoubleSet

equals

Methods inherited from class bak.pcj.AbstractDoubleCollection

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.DoubleCollection

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

DoubleChainedHashSet

public DoubleChainedHashSet()

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

DoubleChainedHashSet

public DoubleChainedHashSet(DoubleCollection 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.

DoubleChainedHashSet

public DoubleChainedHashSet(double[] 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

DoubleChainedHashSet

public DoubleChainedHashSet(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.

DoubleChainedHashSet

public DoubleChainedHashSet(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.

DoubleChainedHashSet

public DoubleChainedHashSet(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.

DoubleChainedHashSet

public DoubleChainedHashSet(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.

DoubleChainedHashSet

public DoubleChainedHashSet(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.

DoubleChainedHashSet

public DoubleChainedHashSet(DoubleHashFunction 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.

DoubleChainedHashSet

public DoubleChainedHashSet(DoubleHashFunction 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.

DoubleChainedHashSet

public DoubleChainedHashSet(DoubleHashFunction 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.

DoubleChainedHashSet

public DoubleChainedHashSet(DoubleHashFunction 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.

DoubleChainedHashSet

public DoubleChainedHashSet(DoubleHashFunction 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.

DoubleChainedHashSet

public DoubleChainedHashSet(DoubleHashFunction 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(double v)

Description copied from interface: DoubleCollection

Adds an element to this collection.

Specified by:

add in interface DoubleCollection

Overrides:

add in class AbstractDoubleCollection

iterator

public DoubleIterator iterator()

Description copied from interface: DoubleCollection

Returns an iterator over this collection.

Specified by:

iterator in interface DoubleCollection

Returns:

an iterator over this collection.

trimToSize

public void trimToSize()

Description copied from interface: DoubleCollection

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 DoubleCollection

Overrides:

trimToSize in class AbstractDoubleCollection

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: DoubleCollection

Returns the number of elements in this collection.

Specified by:

size in interface DoubleCollection

Overrides:

size in class AbstractDoubleCollection

clear

public void clear()

Description copied from interface: DoubleCollection

Clears this collection.

Specified by:

clear in interface DoubleCollection

Overrides:

clear in class AbstractDoubleCollection

contains

public boolean contains(double v)

Description copied from interface: DoubleCollection

Indicates whether this collection contains a specified element.

Specified by:

contains in interface DoubleCollection

Overrides:

contains in class AbstractDoubleCollection

hashCode

public int hashCode()

Description copied from interface: DoubleCollection

Returns a hash code value for this collection.

Specified by:

hashCode in interface DoubleCollection

Overrides:

hashCode in class AbstractDoubleSet

remove

public boolean remove(double v)

Description copied from interface: DoubleCollection

Removes a specified element from this collection.

Specified by:

remove in interface DoubleCollection

Overrides:

remove in class AbstractDoubleCollection

toArray

public double[] toArray(double[] a)

Description copied from interface: DoubleCollection

Returns the elements of this collection as an array.

Specified by:

toArray in interface DoubleCollection

Overrides:

toArray in class AbstractDoubleCollection