Class BooleanArraySet

java.lang.Object
java.util.AbstractCollection<Boolean>
it.unimi.dsi.fastutil.booleans.AbstractBooleanCollection
it.unimi.dsi.fastutil.booleans.AbstractBooleanSet
it.unimi.dsi.fastutil.booleans.BooleanArraySet
All Implemented Interfaces:
it.unimi.dsi.fastutil.booleans.BooleanCollection, it.unimi.dsi.fastutil.booleans.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:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected boolean[]
    The backing array (valid up to size, excluded).
    protected int
    The number of valid entries in a.
  • Constructor Summary

    Constructors
    Constructor
    Description
    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(int capacity)
    Creates a new empty array set of given initial capacity.
    BooleanArraySet(it.unimi.dsi.fastutil.booleans.BooleanCollection c)
    Creates a new array set copying the contents of a given collection.
    Creates a new array set copying the contents of a given collection.
    Creates a new array set copying the contents of a given set.
    BooleanArraySet(Set<? extends Boolean> c)
    Creates a new array set copying the contents of a given set.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    add(boolean k)
     
    void
     
    Returns a deep copy of this set.
    boolean
    contains(boolean k)
     
    boolean
     
    it.unimi.dsi.fastutil.booleans.BooleanIterator
    Returns a type-specific iterator on the elements of this set.
    of()
    Creates a new empty array set.
    of(boolean e)
    Creates a new array set using the element given.
    of(boolean... a)
    Creates a new array set using an array of elements.
    Creates a new empty array set.
    ofUnchecked(boolean... a)
    Creates a new array set using an array of elements.
    boolean
    remove(boolean k)
    Removes an element from this set.
    int
     
    it.unimi.dsi.fastutil.booleans.BooleanSpliterator
    Returns a type-specific spliterator on the elements of this set.
    boolean[]
    toArray(boolean[] a)
     
    boolean[]
     

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

    equals, hashCode, rem

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

    add, addAll, addAll, contains, containsAll, containsAll, remove, removeAll, removeAll, retainAll, retainAll, toBooleanArray, toString

    Methods inherited from class java.util.AbstractCollection

    toArray, toArray

    Methods inherited from class java.lang.Object

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

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

    addAll, containsAll, removeAll, removeIf, removeIf, retainAll, toBooleanArray

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

    forEach, forEach

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

    add, contains, remove

    Methods inherited from interface java.util.Collection

    parallelStream, stream, toArray

    Methods inherited from interface java.util.Set

    addAll, containsAll, removeAll, retainAll, toArray, toArray
  • Field Details

    • a

      protected transient boolean[] a
      The backing array (valid up to size, excluded).
    • size

      protected int size
      The number of valid entries in a.
  • Constructor Details

    • BooleanArraySet

      public BooleanArraySet(boolean[] 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.
    • 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(it.unimi.dsi.fastutil.booleans.BooleanCollection c)
      Creates a new array set copying the contents of a given collection.
      Parameters:
      c - a collection.
    • BooleanArraySet

      public BooleanArraySet(Collection<? extends Boolean> c)
      Creates a new array set copying the contents of a given set.
      Parameters:
      c - a collection.
    • BooleanArraySet

      public BooleanArraySet(BooleanSet c)
      Creates a new array set copying the contents of a given collection.
      Parameters:
      c - a collection.
    • BooleanArraySet

      public BooleanArraySet(Set<? extends Boolean> c)
      Creates a new array set copying the contents of a given set.
      Parameters:
      c - a collection.
    • 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 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 BooleanArraySet of()
      Creates a new empty array set.
      Returns:
      a new empty array set.
    • of

      public static BooleanArraySet of(boolean 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 BooleanArraySet of(boolean... 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 BooleanArraySet ofUnchecked()
      Creates a new empty array set.
      Returns:
      a new empty array set.
    • ofUnchecked

      public static BooleanArraySet ofUnchecked(boolean... 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.booleans.BooleanIterator iterator()
      Description copied from interface: BooleanSet
      Returns a type-specific iterator on the elements of this set.
      Specified by:
      iterator in interface it.unimi.dsi.fastutil.booleans.BooleanCollection
      Specified by:
      iterator in interface it.unimi.dsi.fastutil.booleans.BooleanIterable
      Specified by:
      iterator in interface BooleanSet
      Specified by:
      iterator in interface Collection<Boolean>
      Specified by:
      iterator in interface Iterable<Boolean>
      Specified by:
      iterator in interface Set<Boolean>
      Specified by:
      iterator in class AbstractBooleanSet
      Returns:
      a type-specific iterator on the elements of this set.
    • spliterator

      public it.unimi.dsi.fastutil.booleans.BooleanSpliterator 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.booleans.BooleanCollection
      Specified by:
      spliterator in interface it.unimi.dsi.fastutil.booleans.BooleanIterable
      Specified by:
      spliterator in interface BooleanSet
      Specified by:
      spliterator in interface Collection<Boolean>
      Specified by:
      spliterator in interface Iterable<Boolean>
      Specified by:
      spliterator in interface Set<Boolean>
      Returns:
    • contains

      public boolean contains(boolean k)
      Specified by:
      contains in interface it.unimi.dsi.fastutil.booleans.BooleanCollection
      Overrides:
      contains in class it.unimi.dsi.fastutil.booleans.AbstractBooleanCollection
    • size

      public int size()
      Specified by:
      size in interface Collection<Boolean>
      Specified by:
      size in interface Set<Boolean>
      Specified by:
      size in class AbstractCollection<Boolean>
    • remove

      public boolean remove(boolean k)
      Description copied from class: AbstractBooleanSet
      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 BooleanSet
      Overrides:
      remove in class AbstractBooleanSet
      See Also:
    • add

      public boolean add(boolean k)
      Specified by:
      add in interface it.unimi.dsi.fastutil.booleans.BooleanCollection
      Overrides:
      add in class it.unimi.dsi.fastutil.booleans.AbstractBooleanCollection
    • clear

      public void clear()
      Specified by:
      clear in interface Collection<Boolean>
      Specified by:
      clear in interface Set<Boolean>
      Overrides:
      clear in class AbstractCollection<Boolean>
    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface Collection<Boolean>
      Specified by:
      isEmpty in interface Set<Boolean>
      Overrides:
      isEmpty in class AbstractCollection<Boolean>
    • toBooleanArray

      public boolean[] toBooleanArray()
      Specified by:
      toBooleanArray in interface it.unimi.dsi.fastutil.booleans.BooleanCollection
      Overrides:
      toBooleanArray in class it.unimi.dsi.fastutil.booleans.AbstractBooleanCollection
    • toArray

      public boolean[] toArray(boolean[] a)
      Specified by:
      toArray in interface it.unimi.dsi.fastutil.booleans.BooleanCollection
      Overrides:
      toArray in class it.unimi.dsi.fastutil.booleans.AbstractBooleanCollection
    • clone

      public BooleanArraySet 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 Object
      Returns:
      a deep copy of this set.