Class DoubleArraySet

java.lang.Object
java.util.AbstractCollection<java.lang.Double>
All Implemented Interfaces:
DoubleCollection, DoubleIterable, DoubleSet, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<java.lang.Double>, java.util.Collection<java.lang.Double>, java.util.Set<java.lang.Double>

public class DoubleArraySet
extends AbstractDoubleSet
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 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​(java.util.Collection<? extends java.lang.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​(java.util.Set<? extends java.lang.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:
      java.lang.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 java.util.Collection<java.lang.Double>
      Specified by:
      iterator in interface DoubleCollection
      Specified by:
      iterator in interface DoubleIterable
      Specified by:
      iterator in interface DoubleSet
      Specified by:
      iterator in interface java.lang.Iterable<java.lang.Double>
      Specified by:
      iterator in interface java.util.Set<java.lang.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 java.util.Collection<java.lang.Double>
      Specified by:
      spliterator in interface DoubleCollection
      Specified by:
      spliterator in interface DoubleIterable
      Specified by:
      spliterator in interface DoubleSet
      Specified by:
      spliterator in interface java.lang.Iterable<java.lang.Double>
      Specified by:
      spliterator in interface java.util.Set<java.lang.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 java.util.Collection<java.lang.Double>
      Specified by:
      size in interface java.util.Set<java.lang.Double>
      Specified by:
      size in class java.util.AbstractCollection<java.lang.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 java.util.Collection<java.lang.Double>
      Specified by:
      clear in interface java.util.Set<java.lang.Double>
      Overrides:
      clear in class java.util.AbstractCollection<java.lang.Double>
    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface java.util.Collection<java.lang.Double>
      Specified by:
      isEmpty in interface java.util.Set<java.lang.Double>
      Overrides:
      isEmpty in class java.util.AbstractCollection<java.lang.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.