Class ShortArraySet
- All Implemented Interfaces:
ShortCollection
,ShortIterable
,ShortSet
,Serializable
,Cloneable
,Iterable<Short>
,Collection<Short>
,Set<Short>
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:
-
Constructor Summary
ConstructorDescriptionCreates a new empty array set.ShortArraySet
(int capacity) Creates a new empty array set of given initial capacity.ShortArraySet
(short[] a) Creates a new array set using the given backing array.ShortArraySet
(short[] a, int size) Creates a new array set using the given backing array and the given number of elements of the array.Creates a new array set copying the contents of a given collection.Creates a new array set copying the contents of a given collection.ShortArraySet
(Collection<? extends Short> c) Creates a new array set copying the contents of a given set.ShortArraySet
(Set<? extends Short> c) Creates a new array set copying the contents of a given set. -
Method Summary
Modifier and TypeMethodDescriptionboolean
add
(short k) Ensures that this collection contains the specified element (optional operation).void
clear()
clone()
Returns a deep copy of this set.boolean
contains
(short k) Returnstrue
if this collection contains the specified element.boolean
isEmpty()
iterator()
Returns a type-specific iterator on the elements of this collection.static ShortArraySet
of()
Creates a new empty array set.static ShortArraySet
of
(short e) Creates a new array set using the element given.static ShortArraySet
of
(short... a) Creates a new array set using an array of elements.static ShortArraySet
Creates a new empty array set.static ShortArraySet
ofUnchecked
(short... a) Creates a new array set using an array of elements.boolean
remove
(short k) Removes an element from this set.int
size()
Returns a type-specific spliterator on the elements of this set.short[]
toArray
(short[] 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.short[]
Returns a primitive type array containing the items of this collection.Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShortSet
equals, hashCode, rem
Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShortCollection
add, addAll, addAll, contains, containsAll, containsAll, remove, removeAll, removeAll, retainAll, retainAll, toShortArray, toString
Methods inherited from class java.util.AbstractCollection
toArray, toArray
Methods inherited from interface java.util.Collection
toArray
Methods inherited from interface java.util.Set
addAll, containsAll, removeAll, retainAll, toArray, toArray
Methods inherited from interface it.unimi.dsi.fastutil.shorts.ShortCollection
addAll, containsAll, intIterator, intParallelStream, intSpliterator, intStream, parallelStream, removeAll, removeIf, removeIf, removeIf, retainAll, stream, toShortArray
Methods inherited from interface it.unimi.dsi.fastutil.shorts.ShortIterable
forEach, forEach, forEach
-
Constructor Details
-
ShortArraySet
public ShortArraySet(short[] 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.
-
ShortArraySet
public ShortArraySet()Creates a new empty array set. -
ShortArraySet
public ShortArraySet(int capacity) Creates a new empty array set of given initial capacity.- Parameters:
capacity
- the initial capacity.
-
ShortArraySet
Creates a new array set copying the contents of a given collection.- Parameters:
c
- a collection.
-
ShortArraySet
Creates a new array set copying the contents of a given set.- Parameters:
c
- a collection.
-
ShortArraySet
Creates a new array set copying the contents of a given collection.- Parameters:
c
- a collection.
-
ShortArraySet
Creates a new array set copying the contents of a given set.- Parameters:
c
- a collection.
-
ShortArraySet
public ShortArraySet(short[] 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 Details
-
of
Creates a new empty array set.- Returns:
- a new empty array set.
-
of
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
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
Creates a new empty array set.- Returns:
- a new empty array set.
-
ofUnchecked
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
Description copied from interface:ShortCollection
Returns a type-specific iterator on the elements of this collection.- Specified by:
iterator
in interfaceCollection<Short>
- Specified by:
iterator
in interfaceIterable<Short>
- Specified by:
iterator
in interfaceSet<Short>
- Specified by:
iterator
in interfaceShortCollection
- Specified by:
iterator
in interfaceShortIterable
- Specified by:
iterator
in interfaceShortSet
- Specified by:
iterator
in classAbstractShortSet
- Returns:
- a type-specific iterator on the elements of this collection.
- See Also:
-
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 interfaceCollection<Short>
- Specified by:
spliterator
in interfaceIterable<Short>
- Specified by:
spliterator
in interfaceSet<Short>
- Specified by:
spliterator
in interfaceShortCollection
- Specified by:
spliterator
in interfaceShortIterable
- Specified by:
spliterator
in interfaceShortSet
- Returns:
- a type-specific spliterator on the elements of this collection.
-
contains
public boolean contains(short k) Description copied from class:AbstractShortCollection
Returnstrue
if this collection contains the specified element.- Specified by:
contains
in interfaceShortCollection
- Overrides:
contains
in classAbstractShortCollection
- See Also:
-
size
public int size()- Specified by:
size
in interfaceCollection<Short>
- Specified by:
size
in interfaceSet<Short>
- Specified by:
size
in classAbstractCollection<Short>
-
remove
public boolean remove(short k) Description copied from class:AbstractShortSet
Removes an element from this set. Delegates to the type-specificrem()
method implemented by type-specific abstractCollection
superclass.- Specified by:
remove
in interfaceShortSet
- Overrides:
remove
in classAbstractShortSet
- See Also:
-
add
public boolean add(short k) Description copied from class:AbstractShortCollection
Ensures that this collection contains the specified element (optional operation).- Specified by:
add
in interfaceShortCollection
- Overrides:
add
in classAbstractShortCollection
- See Also:
-
clear
public void clear()- Specified by:
clear
in interfaceCollection<Short>
- Specified by:
clear
in interfaceSet<Short>
- Overrides:
clear
in classAbstractCollection<Short>
-
isEmpty
public boolean isEmpty()- Specified by:
isEmpty
in interfaceCollection<Short>
- Specified by:
isEmpty
in interfaceSet<Short>
- Overrides:
isEmpty
in classAbstractCollection<Short>
-
toShortArray
public short[] toShortArray()Description copied from interface:ShortCollection
Returns a primitive type array containing the items of this collection.- Specified by:
toShortArray
in interfaceShortCollection
- Overrides:
toShortArray
in classAbstractShortCollection
- Returns:
- a primitive type array containing the items of this collection.
- See Also:
-
toArray
public short[] toArray(short[] a) Description copied from interface:ShortCollection
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 interfaceShortCollection
- Overrides:
toArray
in classAbstractShortCollection
- 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:
-
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.
-