edu.ucla.sspace.util.primitive

Class CompactIntSet

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<Integer>

edu.ucla.sspace.util.primitive.AbstractIntSet

edu.ucla.sspace.util.primitive.CompactIntSet

All Implemented Interfaces:

IntCollection, IntSet, Serializable, Iterable<Integer>, Collection<Integer>, Set<Integer>

public class CompactIntSet
extends AbstractIntSet
implements Serializable

A BitSet-backed Set implementation for storing non-negative int values. This set offers a space-efficient method for storing small, or densly populated sets of ints.

Because this class only supports storing non-negative values in the set, any attempt to add a negative value will throw an IllegalArgumentException. The contains and remove methods will also always return false.

This class provides overloads of the common Set operation with the primitive int and Integer values. Callers may use the primitive overloads to avoid auto-boxing the int values. Furthermore, this class provides overloads for the addAll, removeAll, and retainAll methos which operate on IntSet instances. These overloaded versions will still operate in O(n) time, but will be much faster than the Collection-based versions.

This class also provides a wrap(BitSet) method for wrapping an existing BitSet as a Set, which acts as a bridge between bit-based and Collections-based operations.

This class is not thread-safe. This class and its iterator implement all of the optional methods.

Author:

David Jurgens

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CompactIntSet() Creates a new, empty set of int values.
CompactIntSet(Collection<Integer> ints) Creates a new set containing all of the specified int values.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(int i)
boolean	add(Integer i)
boolean	addAll(CompactIntSet ints) Adds to this set all of the elements that are contained in the specified CompactIntSet if not already present, using an CompactIntSet-optimized process.
boolean	contains(int i)
boolean	contains(Integer i)
boolean	isEmpty()
IntIterator	iterator()
boolean	remove(int i)
boolean	remove(Integer i)
boolean	removeAll(CompactIntSet ints) Removes from this set all of the elements that are contained in the specified CompactIntSet using an CompactIntSet-optimized process.
boolean	retainAll(CompactIntSet ints) Retains only the elements in this set that are contained in the specified CompactIntSet using an CompactIntSet-optimized process.
int	size()
static IntSet	wrap(BitSet b) Wraps the provided BitSet as a Set returning the result.

Methods inherited from class edu.ucla.sspace.util.primitive.AbstractIntSet

addAll, containsAll, removeAll, retainAll, toPrimitiveArray

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, clear, contains, containsAll, remove, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

addAll, clear, contains, containsAll, equals, hashCode, remove, removeAll, retainAll, toArray, toArray

Constructor Detail

CompactIntSet

public CompactIntSet()

Creates a new, empty set of int values.

CompactIntSet

public CompactIntSet(Collection<Integer> ints)

Creates a new set containing all of the specified int values.

Method Detail

add

public boolean add(Integer i)

Specified by:

add in interface Collection<Integer>

Specified by:

add in interface Set<Integer>

Overrides:

add in class AbstractCollection<Integer>

add

public boolean add(int i)

Specified by:

add in interface IntCollection

Specified by:

add in interface IntSet

Overrides:

add in class AbstractIntSet

addAll

public boolean addAll(CompactIntSet ints)

Adds to this set all of the elements that are contained in the specified CompactIntSet if not already present, using an CompactIntSet-optimized process.

contains

public boolean contains(Integer i)

contains

public boolean contains(int i)

Specified by:

contains in interface IntCollection

Specified by:

contains in interface IntSet

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<Integer>

Specified by:

isEmpty in interface Set<Integer>

Overrides:

isEmpty in class AbstractCollection<Integer>

iterator

public IntIterator iterator()

Specified by:

iterator in interface IntCollection

Specified by:

iterator in interface IntSet

Specified by:

iterator in interface Iterable<Integer>

Specified by:

iterator in interface Collection<Integer>

Specified by:

iterator in interface Set<Integer>

Specified by:

iterator in class AbstractIntSet

remove

public boolean remove(Integer i)

remove

public boolean remove(int i)

Specified by:

remove in interface IntCollection

Specified by:

remove in interface IntSet

Overrides:

remove in class AbstractIntSet

removeAll

public boolean removeAll(CompactIntSet ints)

Removes from this set all of the elements that are contained in the specified CompactIntSet using an CompactIntSet-optimized process.

retainAll

public boolean retainAll(CompactIntSet ints)

Retains only the elements in this set that are contained in the specified CompactIntSet using an CompactIntSet-optimized process.

size

public int size()

Specified by:

size in interface Collection<Integer>

Specified by:

size in interface Set<Integer>

Specified by:

size in class AbstractCollection<Integer>

wrap

public static IntSet wrap(BitSet b)

Wraps the provided BitSet as a Set returning the result. Any changes to the set will be reflected in b and vice-versa.