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