Package it.unimi.dsi.fastutil.shorts

Class ShortBigArrayBigList

java.lang.Object

java.util.AbstractCollection<Short>

it.unimi.dsi.fastutil.shorts.AbstractShortCollection

it.unimi.dsi.fastutil.shorts.AbstractShortBigList

it.unimi.dsi.fastutil.shorts.ShortBigArrayBigList

All Implemented Interfaces:

BigList<Short>, ShortBigList, ShortCollection, ShortIterable, ShortStack, Size64, Stack<Short>, Serializable, Cloneable, Comparable<BigList<? extends Short>>, Iterable<Short>, Collection<Short>, RandomAccess

public class ShortBigArrayBigList
extends AbstractShortBigList
implements RandomAccess, Cloneable, Serializable

A type-specific big list based on a big array; provides some additional methods that use polymorphism to avoid (un)boxing.

This class implements a lightweight, fast, open, optimized, reuse-oriented version of big-array-based big lists. Instances of this class represent a big list with a big 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 big 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 big 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.shorts.AbstractShortBigList

AbstractShortBigList.ShortRandomAccessSubList, AbstractShortBigList.ShortSubList

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
ShortBigArrayBigList()	Creates a new big-array big list with DEFAULT_INITIAL_CAPACITY capacity.
ShortBigArrayBigList(long capacity)	Creates a new big-array big list with given capacity.
ShortBigArrayBigList(short[][] a)	Creates a new big-array big list and fills it with the elements of a given big array.
ShortBigArrayBigList(short[][] a, long offset, long length)	Creates a new big-array big list and fills it with the elements of a given big array.
ShortBigArrayBigList(ShortBigList l)	Creates a new big-array big list and fills it with a given type-specific list.
ShortBigArrayBigList(ShortCollection c)	Creates a new big-array big list and fills it with a given type-specific collection.
ShortBigArrayBigList(ShortIterator i)	Creates a new big-array big list and fills it with the elements returned by a type-specific iterator..
ShortBigArrayBigList(Iterator<? extends Short> i)	Creates a new big-array big list and fills it with the elements returned by an iterator..

Method Summary

Modifier and Type	Method	Description
void	add(long index, short k)	Inserts the specified element at the specified position in this type-specific big list (optional operation).
boolean	add(short k)	Ensures that this collection contains the specified element (optional operation).
boolean	addAll(long index, ShortBigList list)	Inserts all of the elements in the specified type-specific big list into this type-specific big list at the specified position (optional operation).
boolean	addAll(long index, ShortCollection c)	Inserts all of the elements in the specified type-specific collection into this type-specific big list at the specified position (optional operation).
boolean	addAll(long index, ShortList list)	Inserts all of the elements in the specified type-specific list into this type-specific big list at the specified position (optional operation).
void	addElements(long index, short[][] a, long offset, long length)	Adds elements to this type-specific list using optimized system calls.
void	clear()
ShortBigArrayBigList	clone()
int	compareTo(BigList<? extends Short> l)	Compares this big list to another object.
int	compareTo(ShortBigArrayBigList l)	Compares this big list to another big list.
short[][]	elements()	Returns the backing big array of this big list.
void	ensureCapacity(long capacity)	Ensures that this big-array big list can contain the given number of entries without resizing.
boolean	equals(ShortBigArrayBigList l)	Compares this type-specific big-array list to another one.
boolean	equals(Object o)
void	forEach(ShortConsumer 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.
void	getElements(long from, short[][] a, long offset, long length)	Copies element of this type-specific list into the given big array using optimized system calls.
void	getElements(long from, short[] a, int offset, int length)	Copies element of this type-specific list into the given array using optimized system calls.
short	getShort(long index)	Returns the element at the specified position.
long	indexOf(short k)	Returns the index of the first occurrence of the specified element in this type-specific big list, or -1 if this big list does not contain the element.
boolean	isEmpty()	Checks whether the stack is empty.
long	lastIndexOf(short k)	Returns the index of the last occurrence of the specified element in this type-specific big list, or -1 if this big list does not contain the element.
ShortBigListIterator	listIterator(long index)	Returns a type-specific list iterator on this type-specific big list starting at a given index.
static ShortBigArrayBigList	of()	Creates a new empty big array list.
static ShortBigArrayBigList	of(short... init)	Creates a big array list using a list of elements.
boolean	rem(short k)	Removes a single instance of the specified element from this collection, if it is present (optional operation).
boolean	removeAll(ShortCollection c)	Remove from this collection all elements in the given type-specific collection.
boolean	removeAll(Collection<?> c)
void	removeElements(long from, long to)	Removes elements of this type-specific list using optimized system calls.
short	removeShort(long index)	Removes the element at the specified position.
short	set(long index, short k)	Replaces the element at the specified position in this big list with the specified element (optional operation).
void	setElements(long index, short[][] a, long offset, long length)	Copies elements in the given big array into this type-specific list using optimized system calls.
void	size(long size)	Sets the size of this big list.
long	size64()	Returns the size of this data structure as a long.
ShortSpliterator	spliterator()	Returns a type-specific spliterator on the elements of this big-list.
ShortBigList	subList(long from, long to)	Returns a type-specific view of the portion of this type-specific big list from the index from, inclusive, to the index to, exclusive.
void	trim()	Trims this big-array big list so that the capacity is equal to the size.
void	trim(long n)	Trims the backing big array if it is too large.
static ShortBigArrayBigList	wrap(short[][] a)	Wraps a given big array into a big-array big list.
static ShortBigArrayBigList	wrap(short[][] a, long length)	Wraps a given big array into a big-array list of given size.

Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShortBigList

add, addAll, addAll, addAll, addElements, contains, get, hashCode, indexOf, intSpliterator, iterator, lastIndexOf, listIterator, peek, peekShort, pop, popShort, push, push, remove, set, size, top, topShort, toString

Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShortCollection

add, contains, containsAll, containsAll, remove, retainAll, retainAll, toArray, toShortArray, toShortArray

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 java.util.Collection

containsAll, retainAll, toArray, toArray, toArray

Methods inherited from interface it.unimi.dsi.fastutil.shorts.ShortBigList

addAll, addAll, setElements, setElements

Methods inherited from interface it.unimi.dsi.fastutil.shorts.ShortCollection

add, contains, containsAll, intIterator, intParallelStream, intStream, parallelStream, remove, removeIf, removeIf, removeIf, retainAll, stream, toArray, toShortArray, toShortArray

Methods inherited from interface it.unimi.dsi.fastutil.shorts.ShortIterable

forEach, forEach

Field Details

DEFAULT_INITIAL_CAPACITY

public static final int DEFAULT_INITIAL_CAPACITY

The initial default capacity of a big-array big list.

See Also:

• Constant Field Values

Constructor Details

ShortBigArrayBigList

public ShortBigArrayBigList(long capacity)

Creates a new big-array big list with given capacity.

Parameters:

capacity - the initial capacity of the array list (may be 0).

ShortBigArrayBigList

public ShortBigArrayBigList()

Creates a new big-array big list with DEFAULT_INITIAL_CAPACITY capacity.

ShortBigArrayBigList

public ShortBigArrayBigList(ShortCollection c)

Creates a new big-array big 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.

ShortBigArrayBigList

public ShortBigArrayBigList(ShortBigList l)

Creates a new big-array big 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.

ShortBigArrayBigList

public ShortBigArrayBigList(short[][] a)

Creates a new big-array big list and fills it with the elements of a given big array.

Parameters:

a - a big array whose elements will be used to fill the array list.

ShortBigArrayBigList

public ShortBigArrayBigList(short[][] a,
 long offset,
 long length)

Creates a new big-array big list and fills it with the elements of a given big array.

Parameters:

a - a big array whose elements will be used to fill the array list.

offset - the first element to use.

length - the number of elements to use.

ShortBigArrayBigList

public ShortBigArrayBigList(Iterator<? extends Short> i)

Creates a new big-array big list and fills it with the elements returned by an iterator..

Parameters:

i - an iterator whose returned elements will fill the array list.

ShortBigArrayBigList

public ShortBigArrayBigList(ShortIterator i)

Creates a new big-array big 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 short[][] elements()

Returns the backing big array of this big list.

Returns:

the backing big array.

wrap

public static ShortBigArrayBigList wrap(short[][] a,
 long length)

Wraps a given big array into a big-array list of given size.

Parameters:

a - a big array to wrap.

length - the length of the resulting big-array list.

Returns:

a new big-array list of the given size, wrapping the given big array.

wrap

public static ShortBigArrayBigList wrap(short[][] a)

Wraps a given big array into a big-array big list.

Parameters:

a - a big array to wrap.

Returns:

a new big-array big list wrapping the given array.

of

public static ShortBigArrayBigList of()

Creates a new empty big array list.

Returns:

a new empty big-array big list.

of

public static ShortBigArrayBigList of(short... init)

Creates a big array list using a list of elements.

Parameters:

init - a list of elements that will be used to initialize the big list. It is possible (but not assured) that the returned big-array big list will be backed by the given array in one of its segments.

Returns:

a new big-array big list containing the given elements.

See Also:

• BigArrays.wrap(byte[])

ensureCapacity

public void ensureCapacity(long capacity)

Ensures that this big-array big list can contain the given number of entries without resizing.

Parameters:

capacity - the new minimum capacity for this big-array big list.

add

public void add(long index,
 short k)

Description copied from class: AbstractShortBigList

Inserts the specified element at the specified position in this type-specific big list (optional operation).

Specified by:

add in interface ShortBigList

Overrides:

add in class AbstractShortBigList

See Also:

• BigList.add(long,Object)

add

public boolean add(short k)

Description copied from class: AbstractShortBigList

Ensures that this collection contains the specified element (optional operation).

Specified by:

add in interface ShortCollection

Overrides:

add in class AbstractShortBigList

See Also:

• Collection.add(Object)

getShort

public short getShort(long index)

Description copied from interface: ShortBigList

Returns the element at the specified position.

Specified by:

getShort in interface ShortBigList

See Also:

• BigList.get(long)

indexOf

public long indexOf(short k)

Description copied from interface: ShortBigList

Returns the index of the first occurrence of the specified element in this type-specific big list, or -1 if this big list does not contain the element.

Specified by:

indexOf in interface ShortBigList

Overrides:

indexOf in class AbstractShortBigList

See Also:

• BigList.indexOf(Object)

lastIndexOf

public long lastIndexOf(short k)

Description copied from interface: ShortBigList

Returns the index of the last occurrence of the specified element in this type-specific big list, or -1 if this big list does not contain the element.

Specified by:

lastIndexOf in interface ShortBigList

Overrides:

lastIndexOf in class AbstractShortBigList

See Also:

• BigList.lastIndexOf(Object)

removeShort

public short removeShort(long index)

Description copied from class: AbstractShortBigList

Removes the element at the specified position.

Specified by:

removeShort in interface ShortBigList

Overrides:

removeShort in class AbstractShortBigList

See Also:

• BigList.remove(long)

rem

public boolean rem(short k)

Description copied from class: AbstractShortBigList

Removes a single instance of the specified element from this collection, if it is present (optional operation).

Specified by:

rem in interface ShortCollection

Overrides:

rem in class AbstractShortBigList

See Also:

• Collection.remove(Object)

set

public short set(long index,
 short k)

Description copied from class: AbstractShortBigList

Replaces the element at the specified position in this big list with the specified element (optional operation).

Specified by:

set in interface ShortBigList

Overrides:

set in class AbstractShortBigList

See Also:

• BigList.set(long,Object)

removeAll

public boolean removeAll(ShortCollection c)

Description copied from interface: ShortCollection

Remove from this collection all elements in the given type-specific collection.

Specified by:

removeAll in interface ShortCollection

Overrides:

removeAll in class AbstractShortCollection

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: AbstractShortCollection

Specified by:

removeAll in interface Collection<Short>

Overrides:

removeAll in class AbstractShortCollection

addAll

public boolean addAll(long index,
 ShortCollection c)

Description copied from class: AbstractShortBigList

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

Specified by:

addAll in interface ShortBigList

Overrides:

addAll in class AbstractShortBigList

See Also:

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

addAll

public boolean addAll(long index,
 ShortBigList list)

Description copied from interface: ShortBigList

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

Specified by:

addAll in interface ShortBigList

See Also:

• BigList.addAll(long,Collection)

addAll

public boolean addAll(long index,
 ShortList list)

Description copied from interface: ShortBigList

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

Specified by:

addAll in interface ShortBigList

See Also:

• BigList.addAll(long,Collection)

clear

public void clear()

Description copied from class: AbstractShortBigList

Specified by:

clear in interface Collection<Short>

Overrides:

clear in class AbstractShortBigList

size64

public long size64()

Description copied from interface: Size64

Returns the size of this data structure as a long.

Specified by:

size64 in interface Size64

Returns:

the size of this data structure.

size

public void size(long size)

Description copied from interface: BigList

Sets the size of this big 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 BigList<Short>

Overrides:

size in class AbstractShortBigList

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<Short>

Specified by:

isEmpty in interface Stack<Short>

Overrides:

isEmpty in class AbstractCollection<Short>

Returns:

true if the stack is empty.

trim

public void trim()

Trims this big-array big list so that the capacity is equal to the size.

See Also:

• ArrayList.trimToSize()

trim

public void trim(long n)

Trims the backing big array if it is too large. If the current big array length is smaller than or equal to n, this method does nothing. Otherwise, it trims the big-array length to the maximum between n and size64().

This method is useful when reusing big lists. Clearing a big list leaves the big-array length untouched. If you are reusing a big list many times, you can call this method with a typical size to avoid keeping around a very large big array just because of a few large transient big lists.

Parameters:

n - the threshold for the trimming.

subList

public ShortBigList subList(long from,
 long to)

Description copied from interface: ShortBigList

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

Specified by:

subList in interface BigList<Short>

Specified by:

subList in interface ShortBigList

Overrides:

subList in class AbstractShortBigList

Parameters:

from - the starting element (inclusive).

to - the ending element (exclusive).

Returns:

a big sublist view of this big list.

See Also:

• BigList.subList(long,long)

getElements

public void getElements(long from,
 short[][] a,
 long offset,
 long length)

Copies element of this type-specific list into the given big array using optimized system calls.

Specified by:

getElements in interface ShortBigList

Overrides:

getElements in class AbstractShortBigList

Parameters:

from - the start index (inclusive).

a - the destination big array.

offset - the offset into the destination array where to store the first element copied.

length - the number of elements to be copied.

getElements

public void getElements(long from,
 short[] 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 ShortBigList

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(long from,
 long to)

Removes elements of this type-specific list using optimized system calls.

Specified by:

removeElements in interface ShortBigList

Overrides:

removeElements in class AbstractShortBigList

Parameters:

from - the start index (inclusive).

to - the end index (exclusive).

addElements

public void addElements(long index,
 short[][] a,
 long offset,
 long length)

Adds elements to this type-specific list using optimized system calls.

Specified by:

addElements in interface ShortBigList

Overrides:

addElements in class AbstractShortBigList

Parameters:

index - the index at which to add elements.

a - the big array containing the elements.

offset - the offset of the first element to add.

length - the number of elements to add.

setElements

public void setElements(long index,
 short[][] a,
 long offset,
 long length)

Copies elements in the given big array into this type-specific list using optimized system calls.

Specified by:

setElements in interface ShortBigList

Overrides:

setElements in class AbstractShortBigList

Parameters:

index - the start index (inclusive).

a - the destination big array.

offset - the offset into the destination array where to store the first element copied.

length - the number of elements to be copied.

forEach

public void forEach(ShortConsumer action)

Description copied from class: AbstractShortBigList

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 ShortIterable

Overrides:

forEach in class AbstractShortBigList

Parameters:

action - the action to be performed for each element.

See Also:

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

listIterator

public ShortBigListIterator listIterator(long index)

Description copied from class: AbstractShortBigList

Returns a type-specific list iterator on this type-specific big list starting at a given index.

Specified by:

listIterator in interface BigList<Short>

Specified by:

listIterator in interface ShortBigList

Overrides:

listIterator in class AbstractShortBigList

Parameters:

index - index of first element to be returned from the big-list iterator.

Returns:

a big-list iterator of the elements in this big list, starting at the specified position in this big list.

See Also:

• BigList.listIterator(long)

spliterator

public ShortSpliterator spliterator()

Description copied from interface: ShortBigList

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

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

See List.spliterator() for more documentation on the requirements of the returned spliterator (despite BigList not being a List, most of the same requirements apply.

Specified by:

spliterator in interface Collection<Short>

Specified by:

spliterator in interface Iterable<Short>

Specified by:

spliterator in interface ShortBigList

Specified by:

spliterator in interface ShortCollection

Specified by:

spliterator in interface ShortIterable

Returns:

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

clone

public ShortBigArrayBigList clone()

equals

public boolean equals(ShortBigArrayBigList l)

Compares this type-specific big-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 big-array list.

Returns:

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

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<Short>

Overrides:

equals in class AbstractShortBigList

compareTo

public int compareTo(ShortBigArrayBigList l)

Compares this big list to another big list.

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

Parameters:

l - a big list.

Returns:

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

compareTo

public int compareTo(BigList<? extends Short> l)

Description copied from class: AbstractShortBigList

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

Specified by:

compareTo in interface Comparable<BigList<? extends Short>>

Overrides:

compareTo in class AbstractShortBigList

Parameters:

l - a big list.

Returns:

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