Package it.unimi.dsi.fastutil.bytes

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 increasing its current length by 50%), 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 of java.util's classes, but they are delayed as much as possible. The backing array is exposed by the elements() method.

This class implements the bulk methods removeElements(), addElements() and getElements() 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.ByteRandomAccessSubList, AbstractByteList.ByteSubList

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_INITIAL_CAPACITY	The initial default capacity of an array list.

Constructor Summary

Constructors

Constructor	Description
ByteArrayList()	Creates a new array list with DEFAULT_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

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.
int	compareTo(List<? extends Byte> l)	Compares this list to another object.
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.
boolean	equals(Object o)
void	forEach(ByteConsumer action)	Performs the given action for each element of this type-specific Iterable until all elements have been processed or the action throws an exception.
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()	Creates a new empty array list.
static ByteArrayList	of(byte... init)	Creates an array list using an array 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.
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.
ByteSpliterator	spliterator()	Returns a type-specific spliterator on the elements of this list.
ByteList	subList(int from, int to)	Returns a type-specific view of the portion of this list from the index from, inclusive, to the index to, exclusive.
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, addElements, contains, hashCode, iterator, listIterator, peekByte, popByte, push, toByteArray, topByte, toString

Methods inherited from class it.unimi.dsi.fastutil.bytes.AbstractByteCollection

add, contains, containsAll, containsAll, remove, removeAll, retainAll, retainAll, toByteArray

Methods inherited from class java.util.AbstractCollection

toArray, toArray

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.bytes.ByteCollection

containsAll, intIterator, intParallelStream, intSpliterator, intStream, parallelStream, removeIf, removeIf, removeIf, retainAll, stream, 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, addAll, contains, get, indexOf, lastIndexOf, remove, remove, replaceAll, replaceAll, replaceAll, set, setElements, setElements, sort, unstableSort

Methods inherited from interface it.unimi.dsi.fastutil.bytes.ByteStack

peek, pop, push, top

Methods inherited from interface java.util.Collection

toArray

Methods inherited from interface java.util.List

containsAll, removeAll, retainAll, toArray, toArray

Field Details

DEFAULT_INITIAL_CAPACITY

public static final int DEFAULT_INITIAL_CAPACITY

The initial default capacity of an array list.

See Also:

• Constant Field Values

Constructor Details

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 with DEFAULT_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 Details

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

public static ByteArrayList of()

Creates a new empty array list.

Returns:

a new empty array list.

of

public static ByteArrayList of(byte... init)

Creates an array list using an array of elements.

Parameters:

init - a the array the will become the new backing array of the array list.

Returns:

a new array list backed by the given array.

See Also:

• wrap(byte[], int)

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).

Specified by:

add in interface ByteList

Overrides:

add in class AbstractByteList

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).

Specified by:

add in interface ByteCollection

Specified by:

add in interface ByteList

Overrides:

add in class AbstractByteList

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 interface ByteList

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 interface ByteList

Overrides:

indexOf in class AbstractByteList

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 interface ByteList

Overrides:

lastIndexOf in class AbstractByteList

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).

Specified by:

removeByte in interface ByteList

Overrides:

removeByte in class AbstractByteList

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).

Specified by:

rem in interface ByteCollection

Overrides:

rem in class AbstractByteList

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).

Specified by:

set in interface ByteList

Overrides:

set in class AbstractByteList

See Also:

• List.set(int,Object)

clear

public void clear()

Description copied from class: AbstractByteList

Specified by:

clear in interface Collection<Byte>

Specified by:

clear in interface List<Byte>

Overrides:

clear in class AbstractByteList

size

public int size()

Specified by:

size in interface Collection<Byte>

Specified by:

size in interface List<Byte>

Specified by:

size in class AbstractCollection<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 interface ByteList

Overrides:

size in class AbstractByteList

Parameters:

size - the new size.

isEmpty

public boolean isEmpty()

Description copied from interface: Stack

Checks whether the stack is empty.

Specified by:

isEmpty in interface Collection<Byte>

Specified by:

isEmpty in interface List<Byte>

Specified by:

isEmpty in interface Stack<Byte>

Overrides:

isEmpty in class AbstractCollection<Byte>

Returns:

true if 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 to n, this method does nothing. Otherwise, it trims the array length to the maximum between n and size().

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.

subList

public ByteList subList(int from,
 int to)

Description copied from interface: ByteList

Returns a type-specific view of the portion of this list from the index from, inclusive, to the index to, exclusive.

Specified by:

subList in interface ByteList

Specified by:

subList in interface List<Byte>

Overrides:

subList in class AbstractByteList

See Also:

• List.subList(int,int)

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 interface ByteList

Overrides:

getElements in class AbstractByteList

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 interface ByteList

Overrides:

removeElements in class AbstractByteList

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 interface ByteList

Overrides:

addElements in class AbstractByteList

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 interface ByteList

Overrides:

setElements in class AbstractByteList

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.

forEach

public void forEach(ByteConsumer action)

Description copied from class: AbstractByteList

Performs the given action for each element of this type-specific Iterable until all elements have been processed or the action throws an exception.

Specified by:

forEach in interface ByteIterable

Overrides:

forEach in class AbstractByteList

Parameters:

action - the action to be performed for each element.

See Also:

• Iterable.forEach(java.util.function.Consumer)

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 interface ByteList

Overrides:

addAll in class AbstractByteList

See Also:

• List.addAll(int,java.util.Collection)

addAll

public boolean addAll(int index,
 ByteList l)

Description copied from interface: ByteList

Inserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).

Specified by:

addAll in interface ByteList

See Also:

• List.addAll(int,Collection)

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 interface ByteCollection

Overrides:

removeAll in class AbstractByteCollection

Parameters:

c - a type-specific collection.

Returns:

true if this collection changed as a result of the call.

See Also:

• Collection.removeAll(Collection)

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 interface ByteCollection

Overrides:

toArray in class AbstractByteList

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[])

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.

Specified by:

listIterator in interface ByteList

Specified by:

listIterator in interface List<Byte>

Overrides:

listIterator in class AbstractByteList

See Also:

• List.listIterator(int)

spliterator

public ByteSpliterator spliterator()

Returns a type-specific spliterator on the elements of this list.

List spliterators must report at least Spliterator.SIZED and Spliterator.ORDERED.

See List.spliterator() for more documentation on the requirements of the returned spliterator.

The returned spliterator is late-binding; it will track structural changes after the current index, up until the first trySplit(), at which point the maximum index will be fixed.
Structural changes before the current index or after the first trySplit() will result in unspecified behavior.

Specified by:

spliterator in interface ByteCollection

Specified by:

spliterator in interface ByteIterable

Specified by:

spliterator in interface ByteList

Specified by:

spliterator in interface Collection<Byte>

Specified by:

spliterator in interface Iterable<Byte>

Specified by:

spliterator in interface List<Byte>

Returns:

a type-specific spliterator on the elements of this collection.

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 interface ByteList

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 interface ByteList

clone

public ByteArrayList clone()

equals

public boolean equals(ByteArrayList l)

Compares this type-specific array list to another one.

Parameters:

l - a type-specific array list.

Returns:

true if the argument contains the same elements of this type-specific array list.

API Notes:

This method exists only for sake of efficiency. The implementation inherited from the abstract implementation would already work.

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<Byte>

Specified by:

equals in interface List<Byte>

Overrides:

equals in class AbstractByteList

compareTo

public int compareTo(ByteArrayList l)

Compares this array list to another array list.

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.

API Notes:

This method exists only for sake of efficiency. The implementation inherited from the abstract implementation would already work.

compareTo

public int compareTo(List<? extends Byte> l)

Description copied from class: AbstractByteList

Compares this list to another object. If the argument is a List, this method performs a lexicographical comparison; otherwise, it throws a ClassCastException.

Specified by:

compareTo in interface Comparable<List<? extends Byte>>

Overrides:

compareTo in class AbstractByteList

Parameters:

l - a list.

Returns:

if the argument is a List, a negative integer, zero, or a positive integer as this list is lexicographically less than, equal to, or greater than the argument.