it.unimi.dsi.fastutil.ints
Class IntArraySet

java.lang.Object
  extended by java.util.AbstractCollection<java.lang.Integer>
      extended by it.unimi.dsi.fastutil.ints.AbstractIntCollection
          extended by it.unimi.dsi.fastutil.ints.AbstractIntSet
              extended by it.unimi.dsi.fastutil.ints.IntArraySet
All Implemented Interfaces:
IntCollection, IntIterable, IntSet, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<java.lang.Integer>, java.util.Collection<java.lang.Integer>, java.util.Set<java.lang.Integer>

public class IntArraySet
extends AbstractIntSet
implements java.io.Serializable, java.lang.Cloneable

A simple, brute-force implementation of a set based on a backing array.

The main purpose of this implementation is that of wrapping cleanly the brute-force approach to the storage of a very small number of items: just put them into an array and scan linearly to find an item.

See Also:
Serialized Form

Constructor Summary
IntArraySet()
          Creates a new empty array set.
IntArraySet(java.util.Collection<? extends java.lang.Integer> c)
          Creates a new array set copying the contents of a given set.
IntArraySet(int capacity)
          Creates a new empty array set of given initial capacity.
IntArraySet(int[] a)
          Creates a new array set using the given backing array.
IntArraySet(int[] a, int size)
          Creates a new array set using the given backing array and the given number of elements of the array.
IntArraySet(IntCollection c)
          Creates a new array set copying the contents of a given collection.
 
Method Summary
 boolean add(int k)
           
 void clear()
           
 IntArraySet clone()
          Returns a deep copy of this set.
 boolean contains(int k)
           
 boolean isEmpty()
           
 IntIterator iterator()
          Returns a type-specific iterator on the elements of this collection.
 boolean remove(int k)
          Removes an element from this set.
 int size()
           
 
Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractIntSet
equals, hashCode, rem, remove
 
Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractIntCollection
add, addAll, addAll, contains, containsAll, containsAll, intIterator, rem, removeAll, removeAll, retainAll, retainAll, toArray, toArray, toArray, toIntArray, toIntArray, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface it.unimi.dsi.fastutil.ints.IntCollection
addAll, containsAll, intIterator, removeAll, retainAll, toArray, toArray, toIntArray, toIntArray
 
Methods inherited from interface java.util.Set
add, addAll, contains, containsAll, removeAll, retainAll, toArray, toArray
 

Constructor Detail

IntArraySet

public IntArraySet(int[] a)
Creates a new array set using the given backing array. The resulting set will have as many elements as the array.

It is responsibility of the caller that the elements of a are distinct.

Parameters:
a - the backing array.

IntArraySet

public IntArraySet()
Creates a new empty array set.


IntArraySet

public IntArraySet(int capacity)
Creates a new empty array set of given initial capacity.

Parameters:
capacity - the initial capacity.

IntArraySet

public IntArraySet(IntCollection c)
Creates a new array set copying the contents of a given collection.

Parameters:
c - a collection.

IntArraySet

public IntArraySet(java.util.Collection<? extends java.lang.Integer> c)
Creates a new array set copying the contents of a given set.

Parameters:
c - a collection.

IntArraySet

public IntArraySet(int[] a,
                   int size)
Creates a new array set using the given backing array and the given number of elements of the array.

It is responsibility of the caller that the first size elements of a are distinct.

Parameters:
a - the backing array.
size - the number of valid elements in a.
Method Detail

iterator

public IntIterator iterator()
Description copied from interface: IntCollection
Returns a type-specific iterator on the elements of this collection.

Note that this specification strengthens the one given in Iterable.iterator(), which was already strengthened in the corresponding type-specific class, but was weakened by the fact that this interface extends Collection.

Specified by:
iterator in interface IntCollection
Specified by:
iterator in interface IntIterable
Specified by:
iterator in interface IntSet
Specified by:
iterator in interface java.lang.Iterable<java.lang.Integer>
Specified by:
iterator in interface java.util.Collection<java.lang.Integer>
Specified by:
iterator in interface java.util.Set<java.lang.Integer>
Specified by:
iterator in class AbstractIntSet
Returns:
a type-specific iterator on the elements of this collection.

contains

public boolean contains(int k)
Specified by:
contains in interface IntCollection
Overrides:
contains in class AbstractIntCollection
See Also:
Collection.contains(Object)

size

public int size()
Specified by:
size in interface java.util.Collection<java.lang.Integer>
Specified by:
size in interface java.util.Set<java.lang.Integer>
Specified by:
size in class java.util.AbstractCollection<java.lang.Integer>

remove

public boolean remove(int k)
Description copied from interface: IntSet
Removes an element from this set.

Note that the corresponding method of the type-specific collection is rem(). This unfortunate situation is caused by the clash with the similarly named index-based method in the List interface.

Specified by:
remove in interface IntSet
Overrides:
remove in class AbstractIntSet
See Also:
Collection.remove(Object)

add

public boolean add(int k)
Specified by:
add in interface IntCollection
Overrides:
add in class AbstractIntCollection
See Also:
Collection.add(Object)

clear

public void clear()
Specified by:
clear in interface java.util.Collection<java.lang.Integer>
Specified by:
clear in interface java.util.Set<java.lang.Integer>
Overrides:
clear in class java.util.AbstractCollection<java.lang.Integer>

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface java.util.Collection<java.lang.Integer>
Specified by:
isEmpty in interface java.util.Set<java.lang.Integer>
Overrides:
isEmpty in class AbstractIntCollection

clone

public IntArraySet clone()
Returns a deep copy of this set.

This method performs a deep copy of this hash set; the data stored in the set, however, is not cloned. Note that this makes a difference only for object keys.

Overrides:
clone in class java.lang.Object
Returns:
a deep copy of this set.