it.unimi.dsi.fastutil.booleans
Class BooleanArraySet

java.lang.Object
  it.unimi.dsi.fastutil.booleans.AbstractBooleanCollection
      it.unimi.dsi.fastutil.booleans.AbstractBooleanSet
          it.unimi.dsi.fastutil.booleans.BooleanArraySet

All Implemented Interfaces:

BooleanCollection, BooleanIterable, BooleanSet, Serializable, Cloneable, Iterable<Boolean>, Collection<Boolean>, Set<Boolean>

public class BooleanArraySet
extends AbstractBooleanSet
implements Serializable, 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

BooleanArraySet()
Creates a new empty array set.

BooleanArraySet(boolean[] a)
Creates a new array set using the given backing array.

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

BooleanArraySet(BooleanSet s)
Creates a new array set copying the contents of a given set.

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

Method Summary

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

Methods inherited from class it.unimi.dsi.fastutil.booleans.AbstractBooleanSet

equals, hashCode, rem, remove

Methods inherited from class it.unimi.dsi.fastutil.booleans.AbstractBooleanCollection

add, addAll, addAll, booleanIterator, contains, containsAll, containsAll, rem, removeAll, removeAll, retainAll, retainAll, toArray, toArray, toArray, toBooleanArray, toBooleanArray, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.booleans.BooleanCollection

addAll, booleanIterator, containsAll, removeAll, retainAll, toArray, toArray, toBooleanArray, toBooleanArray

Methods inherited from interface java.util.Set

add, addAll, contains, containsAll, removeAll, retainAll, toArray, toArray

Constructor Detail

BooleanArraySet

public BooleanArraySet(boolean[] a)

Creates a new array set using the given backing array.

Parameters:

a - the backing array.

BooleanArraySet

public BooleanArraySet()

Creates a new empty array set.

BooleanArraySet

public BooleanArraySet(int capacity)

Creates a new empty array set of given initial capacity.

Parameters:

capacity - the initial capacity.

BooleanArraySet

public BooleanArraySet(BooleanSet s)

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

BooleanArraySet

public BooleanArraySet(boolean[] 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 (of course, distinct by identity, not by Object.equals(Object)).

Parameters:

a - the backing array.

size - the number of valid elements in a.

Method Detail

iterator

public BooleanIterator iterator()

Description copied from interface: BooleanCollection

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 BooleanCollection

Specified by:

iterator in interface BooleanIterable

Specified by:

iterator in interface BooleanSet

Specified by:

iterator in interface Iterable<Boolean>

Specified by:

iterator in interface Collection<Boolean>

Specified by:

iterator in interface Set<Boolean>

Specified by:

iterator in class AbstractBooleanSet

Returns:

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

contains

public boolean contains(boolean k)

Specified by:

contains in interface BooleanCollection

See Also:

Collection.contains(Object)

size

public int size()

Specified by:

size in interface Collection<Boolean>

Specified by:

size in interface Set<Boolean>

remove

public boolean remove(boolean k)

Description copied from interface: BooleanSet

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 BooleanSet

Overrides:

remove in class AbstractBooleanSet

See Also:

Collection.remove(Object)

add

public boolean add(boolean k)

Specified by:

add in interface BooleanCollection

Overrides:

add in class AbstractBooleanCollection

See Also:

Collection.add(Object)

clear

public void clear()

Specified by:

clear in interface Collection<Boolean>

Specified by:

clear in interface Set<Boolean>

Overrides:

clear in class AbstractBooleanCollection

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<Boolean>

Specified by:

isEmpty in interface Set<Boolean>

Overrides:

isEmpty in class AbstractBooleanCollection

clone

public Object 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 Object

Returns:

a deep copy of this set.