it.unimi.dsi.fastutil.objects

Class ReferenceArraySet<K>

java.lang.Object

java.util.AbstractCollection<K>

it.unimi.dsi.fastutil.objects.AbstractReferenceCollection<K>

it.unimi.dsi.fastutil.objects.AbstractReferenceSet<K>

it.unimi.dsi.fastutil.objects.ReferenceArraySet<K>

All Implemented Interfaces:

it.unimi.dsi.fastutil.objects.ObjectIterable<K>, it.unimi.dsi.fastutil.objects.ReferenceCollection<K>, ReferenceSet<K>, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<K>, java.util.Collection<K>, java.util.Set<K>

public class ReferenceArraySet<K>
extends AbstractReferenceSet<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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Object[]	a The backing array (valid up to size, excluded).
protected int	size The number of valid entries in a.

Constructor Summary

Constructors

Constructor and Description
ReferenceArraySet() Creates a new empty array set.
ReferenceArraySet(java.util.Collection<? extends K> c) Creates a new array set copying the contents of a given set.
ReferenceArraySet(int capacity) Creates a new empty array set of given initial capacity.
ReferenceArraySet(java.lang.Object[] a) Creates a new array set using the given backing array.
ReferenceArraySet(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.
ReferenceArraySet(it.unimi.dsi.fastutil.objects.ReferenceCollection<K> c) Creates a new array set copying the contents of a given collection.
ReferenceArraySet(ReferenceSet<K> c) Creates a new array set copying the contents of a given collection.
ReferenceArraySet(java.util.Set<? extends K> c) Creates a new array set copying the contents of a given set.

Method Summary

Modifier and Type	Method and Description
boolean	add(K k)
void	clear()
ReferenceArraySet<K>	clone() Returns a deep copy of this set.
boolean	contains(java.lang.Object k)
boolean	isEmpty()
it.unimi.dsi.fastutil.objects.ObjectIterator<K>	iterator() Returns a type-specific iterator on the elements of this set.
static <K> ReferenceArraySet<K>	of() Creates a new empty array set.
static <K> ReferenceArraySet<K>	of(K... a) Creates a new array set using an array of elements.
static <K> ReferenceArraySet<K>	of(K e) Creates a new array set using the element given.
static <K> ReferenceArraySet<K>	ofUnchecked() Creates a new empty array set.
static <K> ReferenceArraySet<K>	ofUnchecked(K... a) Creates a new array set using an array of elements.
boolean	remove(java.lang.Object k)
int	size()
it.unimi.dsi.fastutil.objects.ObjectSpliterator<K>	spliterator() Returns a type-specific spliterator on the elements of this set.
java.lang.Object[]	toArray()
<T> T[]	toArray(T[] a)

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

equals, hashCode

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

toString

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, removeAll, retainAll

Methods inherited from class java.lang.Object

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

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

of, of

Methods inherited from interface java.util.Set

addAll, containsAll, removeAll, retainAll

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

a

protected transient java.lang.Object[] a

The backing array (valid up to size, excluded).

size

protected int size

The number of valid entries in a.

Constructor Detail

ReferenceArraySet

public ReferenceArraySet(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 the responsibility of the caller to ensure that the elements of a are distinct.

Parameters:

a - the backing array.

ReferenceArraySet

public ReferenceArraySet()

Creates a new empty array set.

ReferenceArraySet

public ReferenceArraySet(int capacity)

Creates a new empty array set of given initial capacity.

Parameters:

capacity - the initial capacity.

ReferenceArraySet

public ReferenceArraySet(it.unimi.dsi.fastutil.objects.ReferenceCollection<K> c)

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

Parameters:

c - a collection.

ReferenceArraySet

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

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

Parameters:

c - a collection.

ReferenceArraySet

public ReferenceArraySet(ReferenceSet<K> c)

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

Parameters:

c - a collection.

ReferenceArraySet

public ReferenceArraySet(java.util.Set<? extends K> c)

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

Parameters:

c - a collection.

ReferenceArraySet

public ReferenceArraySet(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 the responsibility of the caller to ensure that the first size elements of a are distinct.

Parameters:

a - the backing array.

size - the number of valid elements in a.

Method Detail

of

public static <K> ReferenceArraySet<K> of()

Creates a new empty array set.

Specified by:

of in interface ReferenceSet<K>

Returns:

a new empty array set.

of

public static <K> ReferenceArraySet<K> of(K e)

Creates a new array set using the element given.

Specified by:

of in interface ReferenceSet<K>

Parameters:

e - the element that the returned set will contain.

Returns:

a new array set containing e.

of

@SafeVarargs
public static <K> ReferenceArraySet<K> of(K... a)

Creates a new array set using an array of elements.

Unlike the array accepting constructors, this method will throw if duplicate elements are encountered. This adds a non-trivial validation burden. Use ofUnchecked() if you know your input has no duplicates, which will skip this validation.

Specified by:

of in interface ReferenceSet<K>

Parameters:

a - the backing array of the returned array set.

Returns:

a new array set containing the elements in a.

Throws:

java.lang.IllegalArgumentException - if there were duplicate entries.

ofUnchecked

public static <K> ReferenceArraySet<K> ofUnchecked()

Creates a new empty array set.

Returns:

a new empty array set.

ofUnchecked

@SafeVarargs
public static <K> ReferenceArraySet<K> ofUnchecked(K... a)

Creates a new array set using an array of elements.

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

Parameters:

a - the backing array of the returned array set.

Returns:

a new array set containing the elements in a.

iterator

public it.unimi.dsi.fastutil.objects.ObjectIterator<K> iterator()

Description copied from interface: ReferenceSet

Returns a type-specific iterator on the elements of this set.

Specified by:

iterator in interface it.unimi.dsi.fastutil.objects.ObjectIterable<K>

Specified by:

iterator in interface it.unimi.dsi.fastutil.objects.ReferenceCollection<K>

Specified by:

iterator in interface ReferenceSet<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 AbstractReferenceSet<K>

Returns:

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

spliterator

public it.unimi.dsi.fastutil.objects.ObjectSpliterator<K> spliterator()

Returns a type-specific spliterator on the elements of this set.

Set spliterators must report at least Spliterator.DISTINCT.

See Set.spliterator() for more documentation on the requirements of the returned spliterator.

In addition to the usual trait of DISTINCT for sets, the returned spliterator will also report the trait ORDERED.

The returned spliterator is late-binding; it will track structural changes after the current item, up until the first trySplit(), at which point the maximum index will be fixed.
Structural changes before the current item or after the first trySplit() will result in unspecified behavior.

Specified by:

spliterator in interface it.unimi.dsi.fastutil.objects.ObjectIterable<K>

Specified by:

spliterator in interface it.unimi.dsi.fastutil.objects.ReferenceCollection<K>

Specified by:

spliterator in interface ReferenceSet<K>

Specified by:

spliterator in interface java.lang.Iterable<K>

Specified by:

spliterator in interface java.util.Collection<K>

Specified by:

spliterator in interface java.util.Set<K>

Returns:

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)

Specified by:

remove in interface java.util.Collection<K>

Specified by:

remove in interface java.util.Set<K>

Overrides:

remove in class java.util.AbstractCollection<K>

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 java.util.AbstractCollection<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 java.util.AbstractCollection<K>

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<K>

Specified by:

toArray in interface java.util.Set<K>

Overrides:

toArray in class java.util.AbstractCollection<K>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface java.util.Collection<K>

Specified by:

toArray in interface java.util.Set<K>

Overrides:

toArray in class java.util.AbstractCollection<K>

clone

public ReferenceArraySet<K> clone()

Returns a deep copy of this set.

This method performs a deep copy of this array 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.