Class CharArraySet

java.lang.Object
java.util.AbstractCollection<Character>
it.unimi.dsi.fastutil.chars.AbstractCharCollection
it.unimi.dsi.fastutil.chars.AbstractCharSet
it.unimi.dsi.fastutil.chars.CharArraySet
All Implemented Interfaces:
it.unimi.dsi.fastutil.chars.CharCollection, it.unimi.dsi.fastutil.chars.CharIterable, CharSet, Serializable, Cloneable, Iterable<Character>, Collection<Character>, Set<Character>

public class CharArraySet extends AbstractCharSet 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 char[]
    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.
    CharArraySet(char[] a)
    Creates a new array set using the given backing array.
    CharArraySet(char[] a, int size)
    Creates a new array set using the given backing array and the given number of elements of the array.
    CharArraySet(int capacity)
    Creates a new empty array set of given initial capacity.
    CharArraySet(it.unimi.dsi.fastutil.chars.CharCollection 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.
    CharArraySet(Set<? extends Character> c)
    Creates a new array set copying the contents of a given set.
  • Method Summary

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

    Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractCharSet

    equals, hashCode, rem

    Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractCharCollection

    add, addAll, addAll, contains, containsAll, containsAll, remove, removeAll, removeAll, retainAll, retainAll, toCharArray, 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.chars.CharCollection

    addAll, containsAll, intIterator, intParallelStream, intSpliterator, intStream, parallelStream, removeAll, removeIf, removeIf, removeIf, retainAll, stream, toCharArray

    Methods inherited from interface it.unimi.dsi.fastutil.chars.CharIterable

    forEach, forEach, forEach

    Methods inherited from interface it.unimi.dsi.fastutil.chars.CharSet

    add, contains, remove

    Methods inherited from interface java.util.Collection

    toArray

    Methods inherited from interface java.util.Set

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

    • a

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

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

    • CharArraySet

      public CharArraySet(char[] 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.
    • CharArraySet

      public CharArraySet()
      Creates a new empty array set.
    • CharArraySet

      public CharArraySet(int capacity)
      Creates a new empty array set of given initial capacity.
      Parameters:
      capacity - the initial capacity.
    • CharArraySet

      public CharArraySet(it.unimi.dsi.fastutil.chars.CharCollection c)
      Creates a new array set copying the contents of a given collection.
      Parameters:
      c - a collection.
    • CharArraySet

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

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

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

      public CharArraySet(char[] 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 CharArraySet of()
      Creates a new empty array set.
      Returns:
      a new empty array set.
    • of

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

      public static CharArraySet ofUnchecked(char... 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.chars.CharIterator iterator()
      Description copied from interface: CharSet
      Returns a type-specific iterator on the elements of this set.
      Specified by:
      iterator in interface it.unimi.dsi.fastutil.chars.CharCollection
      Specified by:
      iterator in interface it.unimi.dsi.fastutil.chars.CharIterable
      Specified by:
      iterator in interface CharSet
      Specified by:
      iterator in interface Collection<Character>
      Specified by:
      iterator in interface Iterable<Character>
      Specified by:
      iterator in interface Set<Character>
      Specified by:
      iterator in class AbstractCharSet
      Returns:
      a type-specific iterator on the elements of this set.
    • spliterator

      public it.unimi.dsi.fastutil.chars.CharSpliterator 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.chars.CharCollection
      Specified by:
      spliterator in interface it.unimi.dsi.fastutil.chars.CharIterable
      Specified by:
      spliterator in interface CharSet
      Specified by:
      spliterator in interface Collection<Character>
      Specified by:
      spliterator in interface Iterable<Character>
      Specified by:
      spliterator in interface Set<Character>
      Returns:
    • contains

      public boolean contains(char k)
      Specified by:
      contains in interface it.unimi.dsi.fastutil.chars.CharCollection
      Overrides:
      contains in class it.unimi.dsi.fastutil.chars.AbstractCharCollection
    • size

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

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

      public boolean add(char k)
      Specified by:
      add in interface it.unimi.dsi.fastutil.chars.CharCollection
      Overrides:
      add in class it.unimi.dsi.fastutil.chars.AbstractCharCollection
    • clear

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

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

      public char[] toCharArray()
      Specified by:
      toCharArray in interface it.unimi.dsi.fastutil.chars.CharCollection
      Overrides:
      toCharArray in class it.unimi.dsi.fastutil.chars.AbstractCharCollection
    • toArray

      public char[] toArray(char[] a)
      Specified by:
      toArray in interface it.unimi.dsi.fastutil.chars.CharCollection
      Overrides:
      toArray in class it.unimi.dsi.fastutil.chars.AbstractCharCollection
    • clone

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