bak.pcj.set
Class CharChainedHashSet

java.lang.Object
  bak.pcj.AbstractCharCollection
      bak.pcj.set.AbstractCharSet
          bak.pcj.set.CharChainedHashSet

All Implemented Interfaces:

CharCollection, CharSet, Cloneable, Serializable

public class CharChainedHashSet

extends AbstractCharSet

implements CharSet, Cloneable, Serializable

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

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

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

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

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

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

CharChainedHashSet(CharHashFunction 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.

CharChainedHashSet(CharHashFunction 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%.

CharChainedHashSet(CharHashFunction 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.

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

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

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

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

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

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

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

equals

Methods inherited from class bak.pcj.AbstractCharCollection

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

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

CharChainedHashSet

public CharChainedHashSet()

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

CharChainedHashSet

public CharChainedHashSet(CharCollection 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.

CharChainedHashSet

public CharChainedHashSet(char[] 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

CharChainedHashSet

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

CharChainedHashSet

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

CharChainedHashSet

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

CharChainedHashSet

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

CharChainedHashSet

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

CharChainedHashSet

public CharChainedHashSet(CharHashFunction 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.

CharChainedHashSet

public CharChainedHashSet(CharHashFunction 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.

CharChainedHashSet

public CharChainedHashSet(CharHashFunction 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.

CharChainedHashSet

public CharChainedHashSet(CharHashFunction 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.

CharChainedHashSet

public CharChainedHashSet(CharHashFunction 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.

CharChainedHashSet

public CharChainedHashSet(CharHashFunction 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(char v)

Description copied from interface: CharCollection

Adds an element to this collection.

Specified by:

add in interface CharCollection

Overrides:

add in class AbstractCharCollection

iterator

public CharIterator iterator()

Description copied from interface: CharCollection

Returns an iterator over this collection.

Specified by:

iterator in interface CharCollection

Returns:

an iterator over this collection.

trimToSize

public void trimToSize()

Description copied from interface: CharCollection

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 CharCollection

Overrides:

trimToSize in class AbstractCharCollection

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

Returns the number of elements in this collection.

Specified by:

size in interface CharCollection

Overrides:

size in class AbstractCharCollection

clear

public void clear()

Description copied from interface: CharCollection

Clears this collection.

Specified by:

clear in interface CharCollection

Overrides:

clear in class AbstractCharCollection

contains

public boolean contains(char v)

Description copied from interface: CharCollection

Indicates whether this collection contains a specified element.

Specified by:

contains in interface CharCollection

Overrides:

contains in class AbstractCharCollection

hashCode

public int hashCode()

Description copied from interface: CharCollection

Returns a hash code value for this collection.

Specified by:

hashCode in interface CharCollection

Overrides:

hashCode in class AbstractCharSet

remove

public boolean remove(char v)

Description copied from interface: CharCollection

Removes a specified element from this collection.

Specified by:

remove in interface CharCollection

Overrides:

remove in class AbstractCharCollection

toArray

public char[] toArray(char[] a)

Description copied from interface: CharCollection

Returns the elements of this collection as an array.

Specified by:

toArray in interface CharCollection

Overrides:

toArray in class AbstractCharCollection