Package it.unimi.dsi.fastutil.doubles

Class DoubleArraySet

java.lang.Object

java.util.AbstractCollection<Double>

it.unimi.dsi.fastutil.doubles.AbstractDoubleCollection

it.unimi.dsi.fastutil.doubles.AbstractDoubleSet

it.unimi.dsi.fastutil.doubles.DoubleArraySet

All Implemented Interfaces:

DoubleCollection, DoubleIterable, DoubleSet, Serializable, Cloneable, Iterable<Double>, Collection<Double>, Set<Double>

public class DoubleArraySet
extends AbstractDoubleSet
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

Constructors

Constructor	Description
DoubleArraySet()	Creates a new empty array set.
DoubleArraySet(double[] a)	Creates a new array set using the given backing array.
DoubleArraySet(double[] a, int size)	Creates a new array set using the given backing array and the given number of elements of the array.
DoubleArraySet(int capacity)	Creates a new empty array set of given initial capacity.
DoubleArraySet(DoubleCollection c)	Creates a new array set copying the contents of a given collection.
DoubleArraySet(DoubleSet c)	Creates a new array set copying the contents of a given collection.
DoubleArraySet(Collection<? extends Double> c)	Creates a new array set copying the contents of a given set.
DoubleArraySet(Set<? extends Double> c)	Creates a new array set copying the contents of a given set.

Method Summary

Modifier and Type	Method	Description
boolean	add(double k)	Ensures that this collection contains the specified element (optional operation).
void	clear()
DoubleArraySet	clone()	Returns a deep copy of this set.
boolean	contains(double k)	Returns true if this collection contains the specified element.
boolean	isEmpty()
DoubleIterator	iterator()	Returns a type-specific iterator on the elements of this collection.
static DoubleArraySet	of()	Creates a new empty array set.
static DoubleArraySet	of(double e)	Creates a new array set using the element given.
static DoubleArraySet	of(double... a)	Creates a new array set using an array of elements.
static DoubleArraySet	ofUnchecked()	Creates a new empty array set.
static DoubleArraySet	ofUnchecked(double... a)	Creates a new array set using an array of elements.
boolean	remove(double k)	Removes an element from this set.
int	size()
DoubleSpliterator	spliterator()	Returns a type-specific spliterator on the elements of this set.
double[]	toArray(double[] a)	Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.
double[]	toDoubleArray()	Returns a primitive type array containing the items of this collection.

Methods inherited from class it.unimi.dsi.fastutil.doubles.AbstractDoubleSet

equals, hashCode, rem

Methods inherited from class it.unimi.dsi.fastutil.doubles.AbstractDoubleCollection

add, addAll, addAll, contains, containsAll, containsAll, forEach, remove, removeAll, removeAll, removeIf, retainAll, retainAll, toDoubleArray, toString

Methods inherited from class java.util.AbstractCollection

toArray, toArray

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

toArray

Methods inherited from interface it.unimi.dsi.fastutil.doubles.DoubleCollection

addAll, containsAll, doubleIterator, doubleParallelStream, doubleSpliterator, doubleStream, parallelStream, removeAll, removeIf, removeIf, removeIf, retainAll, stream, toDoubleArray

Methods inherited from interface it.unimi.dsi.fastutil.doubles.DoubleIterable

forEach, forEach, forEach

Methods inherited from interface it.unimi.dsi.fastutil.doubles.DoubleSet

add, contains, remove

Methods inherited from interface java.util.Set

addAll, containsAll, removeAll, retainAll, toArray, toArray

Constructor Details

DoubleArraySet

public DoubleArraySet(double[] 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.

DoubleArraySet

public DoubleArraySet()

Creates a new empty array set.

DoubleArraySet

public DoubleArraySet(int capacity)

Creates a new empty array set of given initial capacity.

Parameters:

capacity - the initial capacity.

DoubleArraySet

public DoubleArraySet(DoubleCollection c)

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

Parameters:

c - a collection.

DoubleArraySet

public DoubleArraySet(Collection<? extends Double> c)

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

Parameters:

c - a collection.

DoubleArraySet

public DoubleArraySet(DoubleSet c)

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

Parameters:

c - a collection.

DoubleArraySet

public DoubleArraySet(Set<? extends Double> c)

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

Parameters:

c - a collection.

DoubleArraySet

public DoubleArraySet(double[] 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 Details

of

public static DoubleArraySet of()

Creates a new empty array set.

Returns:

a new empty array set.

of

public static DoubleArraySet of(double e)

Creates a new array set using the element given.

Parameters:

e - the element that the returned set will contain.

Returns:

a new array set containing e.

of

public static DoubleArraySet of(double... 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.

Parameters:

a - the backing array of the returned array set.

Returns:

a new array set containing the elements in a.

Throws:

IllegalArgumentException - if there were duplicate entries.

ofUnchecked

public static DoubleArraySet ofUnchecked()

Creates a new empty array set.

Returns:

a new empty array set.

ofUnchecked

public static DoubleArraySet ofUnchecked(double... 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 DoubleIterator iterator()

Description copied from interface: DoubleCollection

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

Specified by:

iterator in interface Collection<Double>

Specified by:

iterator in interface DoubleCollection

Specified by:

iterator in interface DoubleIterable

Specified by:

iterator in interface DoubleSet

Specified by:

iterator in interface Iterable<Double>

Specified by:

iterator in interface Set<Double>

Specified by:

iterator in class AbstractDoubleSet

Returns:

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

See Also:

• Iterable.iterator()

spliterator

public DoubleSpliterator 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 Collection<Double>

Specified by:

spliterator in interface DoubleCollection

Specified by:

spliterator in interface DoubleIterable

Specified by:

spliterator in interface DoubleSet

Specified by:

spliterator in interface Iterable<Double>

Specified by:

spliterator in interface Set<Double>

Returns:

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

contains

public boolean contains(double k)

Description copied from class: AbstractDoubleCollection

Returns true if this collection contains the specified element.

Specified by:

contains in interface DoubleCollection

Overrides:

contains in class AbstractDoubleCollection

See Also:

• Collection.contains(Object)

size

public int size()

Specified by:

size in interface Collection<Double>

Specified by:

size in interface Set<Double>

Specified by:

size in class AbstractCollection<Double>

remove

public boolean remove(double k)

Description copied from class: AbstractDoubleSet

Removes an element from this set. Delegates to the type-specific rem() method implemented by type-specific abstract Collection superclass.

Specified by:

remove in interface DoubleSet

Overrides:

remove in class AbstractDoubleSet

See Also:

• Collection.remove(Object)

add

public boolean add(double k)

Description copied from class: AbstractDoubleCollection

Ensures that this collection contains the specified element (optional operation).

Specified by:

add in interface DoubleCollection

Overrides:

add in class AbstractDoubleCollection

See Also:

• Collection.add(Object)

clear

public void clear()

Specified by:

clear in interface Collection<Double>

Specified by:

clear in interface Set<Double>

Overrides:

clear in class AbstractCollection<Double>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<Double>

Specified by:

isEmpty in interface Set<Double>

Overrides:

isEmpty in class AbstractCollection<Double>

toDoubleArray

public double[] toDoubleArray()

Description copied from interface: DoubleCollection

Returns a primitive type array containing the items of this collection.

Specified by:

toDoubleArray in interface DoubleCollection

Overrides:

toDoubleArray in class AbstractDoubleCollection

Returns:

a primitive type array containing the items of this collection.

See Also:

• Collection.toArray()

toArray

public double[] toArray(double[] a)

Description copied from interface: DoubleCollection

Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.

Note that, contrarily to Collection.toArray(Object[]), this methods just writes all elements of this collection: no special value will be added after the last one.

Specified by:

toArray in interface DoubleCollection

Overrides:

toArray in class AbstractDoubleCollection

Parameters:

a - if this array is big enough, it will be used to store this collection.

Returns:

a primitive type array containing the items of this collection.

See Also:

• Collection.toArray(Object[])

clone

public DoubleArraySet 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.

Returns:

a deep copy of this set.