CharArraySet (char-sets 8.5.13-SNAPSHOT API)

java.lang.Object
- java.util.AbstractCollection<java.lang.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, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<java.lang.Character>, java.util.Collection<java.lang.Character>, java.util.Set<java.lang.Character>
```
public class CharArraySet
extends AbstractCharSet
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 char[] a
The backing array (valid up to size, excluded).

protected int size
The number of valid entries in a.

Fields
Modifier and Type	Field and Description
`protected char[]`	`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
`CharArraySet()` 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(it.unimi.dsi.fastutil.chars.CharCollection c)` Creates a new array set copying the contents of a given collection.
`CharArraySet(CharSet c)` Creates a new array set copying the contents of a given collection.
`CharArraySet(java.util.Collection<? extends java.lang.Character> c)` Creates a new array set copying the contents of a given set.
`CharArraySet(int capacity)` Creates a new empty array set of given initial capacity.
`CharArraySet(java.util.Set<? extends java.lang.Character> c)` Creates a new array set copying the contents of a given set.

Method Summary

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

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.CharSet
add, contains, of, of, remove

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 java.util.Set
addAll, containsAll, removeAll, retainAll, toArray, toArray

- Field Detail
  - 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 Detail
  - 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(java.util.Collection<? extends java.lang.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(java.util.Set<? extends java.lang.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 Detail
  - of
```
public static CharArraySet of()
```
    Creates a new empty array set.
    
    Specified by:
    
    of in interface CharSet
    
    Returns:
    
    a new empty array set.
  - of
```
public static CharArraySet of(char e)
```
    Creates a new array set using the element given.
    
    Specified by:
    
    of in interface CharSet
    
    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.
    
    Specified by:
    
    of in interface CharSet
    
    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 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 java.lang.Iterable<java.lang.Character>
    
    Specified by:
    
    iterator in interface java.util.Collection<java.lang.Character>
    
    Specified by:
    
    iterator in interface java.util.Set<java.lang.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 java.lang.Iterable<java.lang.Character>
    
    Specified by:
    
    spliterator in interface java.util.Collection<java.lang.Character>
    
    Specified by:
    
    spliterator in interface java.util.Set<java.lang.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 java.util.Collection<java.lang.Character>
    
    Specified by:
    
    size in interface java.util.Set<java.lang.Character>
    
    Specified by:
    
    size in class java.util.AbstractCollection<java.lang.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:
    
    Collection.remove(Object)
  - 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 java.util.Collection<java.lang.Character>
    
    Specified by:
    
    clear in interface java.util.Set<java.lang.Character>
    
    Overrides:
    
    clear in class java.util.AbstractCollection<java.lang.Character>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface java.util.Collection<java.lang.Character>
    
    Specified by:
    
    isEmpty in interface java.util.Set<java.lang.Character>
    
    Overrides:
    
    isEmpty in class java.util.AbstractCollection<java.lang.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 java.lang.Object
    
    Returns:
    
    a deep copy of this set.

Class CharArraySet

Field Summary

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

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

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

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

Methods inherited from interface java.util.Set

Field Detail

a

size

Constructor Detail

CharArraySet

CharArraySet

CharArraySet

CharArraySet

CharArraySet

CharArraySet

CharArraySet

CharArraySet

Method Detail

of

of

of

ofUnchecked

ofUnchecked

iterator

spliterator

contains

size

remove

add

clear

isEmpty

toCharArray

toArray

clone