Class ByteArrayList
- java.lang.Object
-
- java.util.AbstractCollection<Byte>
-
- it.unimi.dsi.fastutil.bytes.AbstractByteCollection
-
- it.unimi.dsi.fastutil.bytes.AbstractByteList
-
- it.unimi.dsi.fastutil.bytes.ByteArrayList
-
- All Implemented Interfaces:
ByteCollection
,ByteIterable
,ByteList
,ByteStack
,Stack<Byte>
,Serializable
,Cloneable
,Comparable<List<? extends Byte>>
,Iterable<Byte>
,Collection<Byte>
,List<Byte>
,RandomAccess
public class ByteArrayList extends AbstractByteList implements RandomAccess, Cloneable, Serializable
A type-specific array-based list; provides some additional methods that use polymorphism to avoid (un)boxing.This class implements a lightweight, fast, open, optimized, reuse-oriented version of array-based lists. Instances of this class represent a list with an array that is enlarged as needed when new entries are created (by doubling its current length), but is never made smaller (even on a
clear()
). A family of trimming methods lets you control the size of the backing array; this is particularly useful if you reuse instances of this class. Range checks are equivalent to those ofjava.util
's classes, but they are delayed as much as possible. The backing array is exposed by theelements()
method.This class implements the bulk methods
removeElements()
,addElements()
andgetElements()
using high-performance system calls (e.g.,System.arraycopy()
instead of expensive loops.- See Also:
ArrayList
, Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.bytes.AbstractByteList
AbstractByteList.ByteSubList
-
-
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_INITIAL_CAPACITY
The initial default capacity of an array list.
-
Constructor Summary
Constructors Constructor Description ByteArrayList()
Creates a new array list withDEFAULT_INITIAL_CAPACITY
capacity.ByteArrayList(byte[] a)
Creates a new array list and fills it with the elements of a given array.ByteArrayList(byte[] a, int offset, int length)
Creates a new array list and fills it with the elements of a given array.ByteArrayList(int capacity)
Creates a new array list with given capacity.ByteArrayList(ByteCollection c)
Creates a new array list and fills it with a given type-specific collection.ByteArrayList(ByteIterator i)
Creates a new array list and fills it with the elements returned by a type-specific iterator..ByteArrayList(ByteList l)
Creates a new array list and fills it with a given type-specific list.ByteArrayList(Collection<? extends Byte> c)
Creates a new array list and fills it with a given collection.ByteArrayList(Iterator<? extends Byte> i)
Creates a new array list and fills it with the elements returned by an iterator..
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
add(byte k)
Ensures that this collection contains the specified element (optional operation).void
add(int index, byte k)
Inserts the specified element at the specified position in this list (optional operation).boolean
addAll(int index, ByteCollection c)
Inserts all of the elements in the specified type-specific collection into this type-specific list at the specified position (optional operation).boolean
addAll(int index, ByteList l)
Inserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).void
addElements(int index, byte[] a, int offset, int length)
Adds elements to this type-specific list using optimized system calls.void
clear()
ByteArrayList
clone()
int
compareTo(ByteArrayList l)
Compares this array list to another array list.byte[]
elements()
Returns the backing array of this list.void
ensureCapacity(int capacity)
Ensures that this array list can contain the given number of entries without resizing.boolean
equals(ByteArrayList l)
Compares this type-specific array list to another one.byte
getByte(int index)
Returns the element at the specified position in this list.void
getElements(int from, byte[] a, int offset, int length)
Copies element of this type-specific list into the given array using optimized system calls.int
indexOf(byte k)
Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.boolean
isEmpty()
Checks whether the stack is empty.int
lastIndexOf(byte k)
Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.ByteListIterator
listIterator(int index)
Returns a type-specific list iterator on the list starting at a given index.static ByteArrayList
of(byte... init)
Creates an array list using a list of elements.boolean
rem(byte k)
Removes a single instance of the specified element from this collection, if it is present (optional operation).boolean
removeAll(ByteCollection c)
Remove from this collection all elements in the given type-specific collection.boolean
removeAll(Collection<?> c)
byte
removeByte(int index)
Removes the element at the specified position in this list (optional operation).void
removeElements(int from, int to)
Removes elements of this type-specific list using optimized system calls.byte
set(int index, byte k)
Replaces the element at the specified position in this list with the specified element (optional operation).void
setElements(int index, byte[] a, int offset, int length)
Sets elements to this type-specific list using optimized system calls.int
size()
void
size(int size)
Sets the size of this list.void
sort(ByteComparator comp)
Sort a list using a type-specific comparator.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.void
trim()
Trims this array list so that the capacity is equal to the size.void
trim(int n)
Trims the backing array if it is too large.void
unstableSort(ByteComparator comp)
Sorts this list using a sort not assured to be stable.static ByteArrayList
wrap(byte[] a)
Wraps a given array into an array list.static ByteArrayList
wrap(byte[] a, int length)
Wraps a given array into an array list of given size.-
Methods inherited from class it.unimi.dsi.fastutil.bytes.AbstractByteList
addAll, addAll, addAll, addAll, addElements, compareTo, contains, equals, hashCode, iterator, listIterator, peekByte, popByte, push, subList, topByte, toString
-
Methods inherited from class it.unimi.dsi.fastutil.bytes.AbstractByteCollection
add, contains, containsAll, containsAll, remove, retainAll, retainAll, toByteArray, toByteArray
-
Methods inherited from class java.util.AbstractCollection
toArray, toArray
-
Methods inherited from interface it.unimi.dsi.fastutil.bytes.ByteCollection
containsAll, removeIf, removeIf, retainAll, toByteArray, toByteArray
-
Methods inherited from interface it.unimi.dsi.fastutil.bytes.ByteIterable
forEach, forEach
-
Methods inherited from interface it.unimi.dsi.fastutil.bytes.ByteList
add, add, contains, get, indexOf, lastIndexOf, remove, remove, set, setElements, setElements, sort, unstableSort
-
Methods inherited from interface java.util.Collection
parallelStream, stream, toArray
-
Methods inherited from interface java.util.List
containsAll, replaceAll, retainAll, spliterator, toArray, toArray
-
-
-
-
Field Detail
-
DEFAULT_INITIAL_CAPACITY
public static final int DEFAULT_INITIAL_CAPACITY
The initial default capacity of an array list.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ByteArrayList
public ByteArrayList(int capacity)
Creates a new array list with given capacity.- Parameters:
capacity
- the initial capacity of the array list (may be 0).
-
ByteArrayList
public ByteArrayList()
Creates a new array list withDEFAULT_INITIAL_CAPACITY
capacity.
-
ByteArrayList
public ByteArrayList(Collection<? extends Byte> c)
Creates a new array list and fills it with a given collection.- Parameters:
c
- a collection that will be used to fill the array list.
-
ByteArrayList
public ByteArrayList(ByteCollection c)
Creates a new array list and fills it with a given type-specific collection.- Parameters:
c
- a type-specific collection that will be used to fill the array list.
-
ByteArrayList
public ByteArrayList(ByteList l)
Creates a new array list and fills it with a given type-specific list.- Parameters:
l
- a type-specific list that will be used to fill the array list.
-
ByteArrayList
public ByteArrayList(byte[] a)
Creates a new array list and fills it with the elements of a given array.- Parameters:
a
- an array whose elements will be used to fill the array list.
-
ByteArrayList
public ByteArrayList(byte[] a, int offset, int length)
Creates a new array list and fills it with the elements of a given array.- Parameters:
a
- an array whose elements will be used to fill the array list.offset
- the first element to use.length
- the number of elements to use.
-
ByteArrayList
public ByteArrayList(Iterator<? extends Byte> i)
Creates a new array list and fills it with the elements returned by an iterator..- Parameters:
i
- an iterator whose returned elements will fill the array list.
-
ByteArrayList
public ByteArrayList(ByteIterator i)
Creates a new array list and fills it with the elements returned by a type-specific iterator..- Parameters:
i
- a type-specific iterator whose returned elements will fill the array list.
-
-
Method Detail
-
elements
public byte[] elements()
Returns the backing array of this list.- Returns:
- the backing array.
-
wrap
public static ByteArrayList wrap(byte[] a, int length)
Wraps a given array into an array list of given size.Note it is guaranteed that the type of the array returned by
elements()
will be the same (see the comments in the class documentation).- Parameters:
a
- an array to wrap.length
- the length of the resulting array list.- Returns:
- a new array list of the given size, wrapping the given array.
-
wrap
public static ByteArrayList wrap(byte[] a)
Wraps a given array into an array list.Note it is guaranteed that the type of the array returned by
elements()
will be the same (see the comments in the class documentation).- Parameters:
a
- an array to wrap.- Returns:
- a new array list wrapping the given array.
-
of
@SafeVarargs public static ByteArrayList of(byte... init)
Creates an array list using a list of elements.- Parameters:
init
- a list of elements that will be used to initialize the list.- Returns:
- a new array list containing the given elements.
-
ensureCapacity
public void ensureCapacity(int capacity)
Ensures that this array list can contain the given number of entries without resizing.- Parameters:
capacity
- the new minimum capacity for this array list.
-
add
public void add(int index, byte k)
Description copied from class:AbstractByteList
Inserts the specified element at the specified position in this list (optional operation).This implementation always throws an
UnsupportedOperationException
.- Specified by:
add
in interfaceByteList
- Overrides:
add
in classAbstractByteList
- See Also:
List.add(int,Object)
-
add
public boolean add(byte k)
Description copied from class:AbstractByteList
Ensures that this collection contains the specified element (optional operation).This implementation always throws an
UnsupportedOperationException
.This implementation delegates to the type-specific version of
List.add(int, Object)
.- Specified by:
add
in interfaceByteCollection
- Specified by:
add
in interfaceByteList
- Overrides:
add
in classAbstractByteList
- See Also:
Collection.add(Object)
-
getByte
public byte getByte(int index)
Description copied from interface:ByteList
Returns the element at the specified position in this list.- Specified by:
getByte
in interfaceByteList
- See Also:
List.get(int)
-
indexOf
public int indexOf(byte k)
Description copied from interface:ByteList
Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.- Specified by:
indexOf
in interfaceByteList
- Overrides:
indexOf
in classAbstractByteList
- See Also:
List.indexOf(Object)
-
lastIndexOf
public int lastIndexOf(byte k)
Description copied from interface:ByteList
Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.- Specified by:
lastIndexOf
in interfaceByteList
- Overrides:
lastIndexOf
in classAbstractByteList
- See Also:
List.lastIndexOf(Object)
-
removeByte
public byte removeByte(int index)
Description copied from class:AbstractByteList
Removes the element at the specified position in this list (optional operation).This implementation always throws an
UnsupportedOperationException
.- Specified by:
removeByte
in interfaceByteList
- Overrides:
removeByte
in classAbstractByteList
- See Also:
List.remove(int)
-
rem
public boolean rem(byte k)
Description copied from class:AbstractByteList
Removes a single instance of the specified element from this collection, if it is present (optional operation).This implementation delegates to
indexOf()
.- Specified by:
rem
in interfaceByteCollection
- Overrides:
rem
in classAbstractByteList
- See Also:
List.remove(Object)
-
set
public byte set(int index, byte k)
Description copied from class:AbstractByteList
Replaces the element at the specified position in this list with the specified element (optional operation).This implementation always throws an
UnsupportedOperationException
.- Specified by:
set
in interfaceByteList
- Overrides:
set
in classAbstractByteList
- See Also:
List.set(int,Object)
-
clear
public void clear()
Description copied from class:AbstractByteList
This implementation delegates to
AbstractByteList.removeElements(int, int)
.- Specified by:
clear
in interfaceCollection<Byte>
- Specified by:
clear
in interfaceList<Byte>
- Overrides:
clear
in classAbstractByteList
-
size
public int size()
- Specified by:
size
in interfaceCollection<Byte>
- Specified by:
size
in interfaceList<Byte>
- Specified by:
size
in classAbstractCollection<Byte>
-
size
public void size(int size)
Description copied from interface:ByteList
Sets the size of this list.If the specified size is smaller than the current size, the last elements are discarded. Otherwise, they are filled with 0/
null
/false
.- Specified by:
size
in interfaceByteList
- Overrides:
size
in classAbstractByteList
- Parameters:
size
- the new size.
-
isEmpty
public boolean isEmpty()
Description copied from interface:Stack
Checks whether the stack is empty.
-
trim
public void trim()
Trims this array list so that the capacity is equal to the size.- See Also:
ArrayList.trimToSize()
-
trim
public void trim(int n)
Trims the backing array if it is too large. If the current array length is smaller than or equal ton
, this method does nothing. Otherwise, it trims the array length to the maximum betweenn
andsize()
.This method is useful when reusing lists. Clearing a list leaves the array length untouched. If you are reusing a list many times, you can call this method with a typical size to avoid keeping around a very large array just because of a few large transient lists.
- Parameters:
n
- the threshold for the trimming.
-
getElements
public void getElements(int from, byte[] a, int offset, int length)
Copies element of this type-specific list into the given array using optimized system calls.- Specified by:
getElements
in interfaceByteList
- Overrides:
getElements
in classAbstractByteList
- Parameters:
from
- the start index (inclusive).a
- the destination array.offset
- the offset into the destination array where to store the first element copied.length
- the number of elements to be copied.
-
removeElements
public void removeElements(int from, int to)
Removes elements of this type-specific list using optimized system calls.- Specified by:
removeElements
in interfaceByteList
- Overrides:
removeElements
in classAbstractByteList
- Parameters:
from
- the start index (inclusive).to
- the end index (exclusive).
-
addElements
public void addElements(int index, byte[] a, int offset, int length)
Adds elements to this type-specific list using optimized system calls.- Specified by:
addElements
in interfaceByteList
- Overrides:
addElements
in classAbstractByteList
- Parameters:
index
- the index at which to add elements.a
- the array containing the elements.offset
- the offset of the first element to add.length
- the number of elements to add.
-
setElements
public void setElements(int index, byte[] a, int offset, int length)
Sets elements to this type-specific list using optimized system calls.- Specified by:
setElements
in interfaceByteList
- Parameters:
index
- the index at which to start setting elements.a
- the array containing the elements.offset
- the offset of the first element to add.length
- the number of elements to add.
-
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:
Collection.toArray(Object[])
-
addAll
public boolean addAll(int index, ByteCollection c)
Description copied from interface:ByteList
Inserts all of the elements in the specified type-specific collection into this type-specific list at the specified position (optional operation).- Specified by:
addAll
in interfaceByteList
- Overrides:
addAll
in classAbstractByteList
- See Also:
List.addAll(int,java.util.Collection)
-
addAll
public boolean addAll(int index, ByteList l)
Description copied from class:AbstractByteList
Inserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).This implementation delegates to the type-specific version of
List.addAll(int, Collection)
.- Specified by:
addAll
in interfaceByteList
- Overrides:
addAll
in classAbstractByteList
- See Also:
List.add(int,Object)
-
removeAll
public boolean removeAll(ByteCollection c)
Description copied from interface:ByteCollection
Remove from this collection all elements in the given type-specific collection.- Specified by:
removeAll
in interfaceByteCollection
- Overrides:
removeAll
in classAbstractByteCollection
- Parameters:
c
- a type-specific collection.- Returns:
true
if this collection changed as a result of the call.- See Also:
Collection.removeAll(Collection)
-
removeAll
public boolean removeAll(Collection<?> c)
Description copied from class:AbstractByteCollection
This implementation delegates to the type-specific version if given a type-specific collection, otherwise is uses the implementation from
AbstractCollection
.- Specified by:
removeAll
in interfaceCollection<Byte>
- Specified by:
removeAll
in interfaceList<Byte>
- Overrides:
removeAll
in classAbstractByteCollection
-
listIterator
public ByteListIterator listIterator(int index)
Description copied from class:AbstractByteList
Returns a type-specific list iterator on the list starting at a given index.This implementation is based on the random-access methods.
- Specified by:
listIterator
in interfaceByteList
- Specified by:
listIterator
in interfaceList<Byte>
- Overrides:
listIterator
in classAbstractByteList
- See Also:
List.listIterator(int)
-
sort
public void sort(ByteComparator comp)
Description copied from interface:ByteList
Sort a list using a type-specific comparator.Pass
null
to sort using natural ordering.- Specified by:
sort
in interfaceByteList
- See Also:
List.sort(java.util.Comparator)
-
unstableSort
public void unstableSort(ByteComparator comp)
Description copied from interface:ByteList
Sorts this list using a sort not assured to be stable.Pass
null
to sort using natural ordering.This differs from
List.sort(java.util.Comparator)
in that the results are not assured to be stable, but may be a bit faster.Unless a subclass specifies otherwise, the results of the method if the list is concurrently modified during the sort are unspecified.
- Specified by:
unstableSort
in interfaceByteList
-
clone
public ByteArrayList clone()
-
equals
public boolean equals(ByteArrayList l)
Compares this type-specific array list to another one.This method exists only for sake of efficiency. The implementation inherited from the abstract implementation would already work.
- Parameters:
l
- a type-specific array list.- Returns:
- true if the argument contains the same elements of this type-specific array list.
-
compareTo
public int compareTo(ByteArrayList l)
Compares this array list to another array list.This method exists only for sake of efficiency. The implementation inherited from the abstract implementation would already work.
- Parameters:
l
- an array list.- Returns:
- a negative integer, zero, or a positive integer as this list is lexicographically less than, equal to, or greater than the argument.
-
-