it.unimi.dsi.fastutil.objects
Class ObjectArraySet<K>

java.lang.Object
  java.util.AbstractCollection<K>
      it.unimi.dsi.fastutil.objects.AbstractObjectCollection<K>
          it.unimi.dsi.fastutil.objects.AbstractObjectSet<K>
              it.unimi.dsi.fastutil.objects.ObjectArraySet<K>

All Implemented Interfaces:

ObjectCollection<K>, ObjectIterable<K>, ObjectSet<K>, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<K>, java.util.Collection<K>, java.util.Set<K>

public class ObjectArraySet<K>
extends AbstractObjectSet<K>
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

ObjectArraySet()
Creates a new empty array set.

ObjectArraySet(java.util.Collection<? extends K> c)
Creates a new array set copying the contents of a given set.

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

ObjectArraySet(java.lang.Object[] a)
Creates a new array set using the given backing array.

ObjectArraySet(java.lang.Object[] a, int size)
Creates a new array set using the given backing array and the given number of elements of the array.

ObjectArraySet(ObjectCollection<K> c)
Creates a new array set copying the contents of a given collection.

Method Summary

boolean	add(K k)
void	clear()
ObjectArraySet<K>	clone() Returns a deep copy of this set.
boolean	contains(java.lang.Object k)
boolean	isEmpty()
ObjectIterator<K>	iterator() Returns a type-specific iterator on the elements of this collection.
boolean	remove(java.lang.Object k) Removes an element from this set.
int	size()

Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObjectSet

equals, hashCode

Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObjectCollection

addAll, containsAll, objectIterator, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.objects.ObjectCollection

objectIterator, toArray

Methods inherited from interface java.util.Set

addAll, containsAll, removeAll, retainAll, toArray, toArray

Constructor Detail

ObjectArraySet

public ObjectArraySet(java.lang.Object[] 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.

ObjectArraySet

public ObjectArraySet()

Creates a new empty array set.

ObjectArraySet

public ObjectArraySet(int capacity)

Creates a new empty array set of given initial capacity.

Parameters:

capacity - the initial capacity.

ObjectArraySet

public ObjectArraySet(ObjectCollection<K> c)

Creates a new array set copying the contents of a given collection.

Parameters:

c - a collection.

ObjectArraySet

public ObjectArraySet(java.util.Collection<? extends K> c)

Creates a new array set copying the contents of a given set.

Parameters:

c - a collection.

ObjectArraySet

public ObjectArraySet(java.lang.Object[] 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 ObjectIterator<K> iterator()

Description copied from interface: ObjectCollection

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 ObjectCollection<K>

Specified by:

iterator in interface ObjectIterable<K>

Specified by:

iterator in interface ObjectSet<K>

Specified by:

iterator in interface java.lang.Iterable<K>

Specified by:

iterator in interface java.util.Collection<K>

Specified by:

iterator in interface java.util.Set<K>

Specified by:

iterator in class AbstractObjectSet<K>

Returns:

a type-specific iterator on the elements of this collection.

contains

public boolean contains(java.lang.Object k)

Specified by:

contains in interface java.util.Collection<K>

Specified by:

contains in interface java.util.Set<K>

Overrides:

contains in class java.util.AbstractCollection<K>

size

public int size()

Specified by:

size in interface java.util.Collection<K>

Specified by:

size in interface java.util.Set<K>

Specified by:

size in class java.util.AbstractCollection<K>

remove

public boolean remove(java.lang.Object k)

Description copied from interface: ObjectSet

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 ObjectSet<K>

Specified by:

remove in interface java.util.Collection<K>

Specified by:

remove in interface java.util.Set<K>

Overrides:

remove in class AbstractObjectSet<K>

See Also:

Collection.remove(Object)

add

public boolean add(K k)

Specified by:

add in interface java.util.Collection<K>

Specified by:

add in interface java.util.Set<K>

Overrides:

add in class AbstractObjectCollection<K>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<K>

Specified by:

clear in interface java.util.Set<K>

Overrides:

clear in class java.util.AbstractCollection<K>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<K>

Specified by:

isEmpty in interface java.util.Set<K>

Overrides:

isEmpty in class AbstractObjectCollection<K>

clone

public ObjectArraySet<K> 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.