Class CharArraySet
- 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:
CharCollection
,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
-
-
Constructor Summary
Constructors Constructor 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(int capacity)
Creates a new empty array set of given initial capacity.CharArraySet(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(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 Description boolean
add(char k)
Ensures that this collection contains the specified element (optional operation).void
clear()
CharArraySet
clone()
Returns a deep copy of this set.boolean
contains(char k)
Returnstrue
if this collection contains the specified element.boolean
isEmpty()
CharIterator
iterator()
Returns a type-specific iterator on the elements of this collection.static CharArraySet
of()
Creates a new empty array set.static CharArraySet
of(char e)
Creates a new array set using the element given.static CharArraySet
of(char... a)
Creates a new array set using an array of elements.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()
CharSpliterator
spliterator()
Returns a type-specific spliterator on the elements of this set.char[]
toArray(char[] 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.char[]
toCharArray()
Returns a primitive type array containing the items of this collection.-
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 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
-
-
-
-
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(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 ofa
are distinct.- Parameters:
a
- the backing array.size
- the number of valid elements ina
.
-
-
Method Detail
-
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:
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 CharIterator iterator()
Description copied from interface:CharCollection
Returns a type-specific iterator on the elements of this collection.- Specified by:
iterator
in interfaceCharCollection
- Specified by:
iterator
in interfaceCharIterable
- Specified by:
iterator
in interfaceCharSet
- Specified by:
iterator
in interfacejava.util.Collection<java.lang.Character>
- Specified by:
iterator
in interfacejava.lang.Iterable<java.lang.Character>
- Specified by:
iterator
in interfacejava.util.Set<java.lang.Character>
- Specified by:
iterator
in classAbstractCharSet
- Returns:
- a type-specific iterator on the elements of this collection.
- See Also:
Iterable.iterator()
-
spliterator
public 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 traitORDERED
.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 firsttrySplit()
will result in unspecified behavior.- Specified by:
spliterator
in interfaceCharCollection
- Specified by:
spliterator
in interfaceCharIterable
- Specified by:
spliterator
in interfaceCharSet
- Specified by:
spliterator
in interfacejava.util.Collection<java.lang.Character>
- Specified by:
spliterator
in interfacejava.lang.Iterable<java.lang.Character>
- Specified by:
spliterator
in interfacejava.util.Set<java.lang.Character>
- Returns:
- a type-specific spliterator on the elements of this collection.
-
contains
public boolean contains(char k)
Description copied from class:AbstractCharCollection
Returnstrue
if this collection contains the specified element.- Specified by:
contains
in interfaceCharCollection
- Overrides:
contains
in classAbstractCharCollection
- See Also:
Collection.contains(Object)
-
size
public int size()
- Specified by:
size
in interfacejava.util.Collection<java.lang.Character>
- Specified by:
size
in interfacejava.util.Set<java.lang.Character>
- Specified by:
size
in classjava.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-specificrem()
method implemented by type-specific abstractCollection
superclass.- Specified by:
remove
in interfaceCharSet
- Overrides:
remove
in classAbstractCharSet
- See Also:
Collection.remove(Object)
-
add
public boolean add(char k)
Description copied from class:AbstractCharCollection
Ensures that this collection contains the specified element (optional operation).- Specified by:
add
in interfaceCharCollection
- Overrides:
add
in classAbstractCharCollection
- See Also:
Collection.add(Object)
-
clear
public void clear()
- Specified by:
clear
in interfacejava.util.Collection<java.lang.Character>
- Specified by:
clear
in interfacejava.util.Set<java.lang.Character>
- Overrides:
clear
in classjava.util.AbstractCollection<java.lang.Character>
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfacejava.util.Collection<java.lang.Character>
- Specified by:
isEmpty
in interfacejava.util.Set<java.lang.Character>
- Overrides:
isEmpty
in classjava.util.AbstractCollection<java.lang.Character>
-
toCharArray
public char[] toCharArray()
Description copied from interface:CharCollection
Returns a primitive type array containing the items of this collection.- Specified by:
toCharArray
in interfaceCharCollection
- Overrides:
toCharArray
in classAbstractCharCollection
- Returns:
- a primitive type array containing the items of this collection.
- See Also:
Collection.toArray()
-
toArray
public char[] toArray(char[] a)
Description copied from interface:CharCollection
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 interfaceCharCollection
- Overrides:
toArray
in classAbstractCharCollection
- 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 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.
- Returns:
- a deep copy of this set.
-
-