Package it.unimi.dsi.fastutil.shorts

Class AbstractShortBigList

java.lang.Object

java.util.AbstractCollection<Short>

it.unimi.dsi.fastutil.shorts.AbstractShortCollection

it.unimi.dsi.fastutil.shorts.AbstractShortBigList

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractShortBigList.ShortSubList, ShortBigArrayBigList, ShortBigLists.ListBigList, ShortBigLists.Singleton, ShortMappedBigList

public abstract class AbstractShortBigList
extends AbstractShortCollection
implements ShortBigList, ShortStack

An abstract class providing basic methods for big lists implementing a type-specific big list interface.

Most of the methods in this class are optimized with the assumption that the List will have have constant-time random access. If this is not the case, you should probably at least override listIterator(long) and the xAll() methods (such as addAll(long, java.util.Collection<? extends java.lang.Short>)) with a more appropriate iteration scheme. Note the subList(long, long) method is cognizant of random-access or not, so that need not be reimplemented.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractShortBigList.ShortRandomAccessSubList
static class	AbstractShortBigList.ShortSubList	A class implementing a sublist view.

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).
void	add(long index, Short ok)	Deprecated. Please use the corresponding type-specific method instead.
boolean	add(short k)	Ensures that this collection contains the specified element (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, Collection<? extends Short> c)	Adds all of the elements in the specified collection to this list (optional operation).
boolean	addAll(ShortCollection c)	Adds all elements of the given type-specific collection to this collection.
boolean	addAll(Collection<? extends Short> c)
void	addElements(long index, short[][] a)	Add (hopefully quickly) elements to this type-specific big list.
void	addElements(long index, short[][] a, long offset, long length)	Add (hopefully quickly) elements to this type-specific big list.
void	clear()
int	compareTo(BigList<? extends Short> l)	Compares this big list to another object.
boolean	contains(short k)	Returns true if this list contains the specified element.
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.
Short	get(long index)	Deprecated. Please use the corresponding type-specific method instead.
void	getElements(long from, short[][] a, long offset, long length)	Copies (hopefully quickly) elements of this type-specific big list into the given big array.
int	hashCode()	Returns the hash code for this big list, which is identical to List.hashCode().
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.
long	indexOf(Object ok)	Deprecated. Please use the corresponding type-specific method instead.
IntSpliterator	intSpliterator()	Returns widened primitive spliterator on the elements of this collection.
ShortBigListIterator	iterator()	Returns a type-specific iterator on the elements of this collection.
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.
long	lastIndexOf(Object ok)	Deprecated. Please use the corresponding type-specific method instead.
ShortBigListIterator	listIterator()	Returns a type-specific big-list iterator on this type-specific big list.
ShortBigListIterator	listIterator(long index)	Returns a type-specific list iterator on this type-specific big list starting at a given index.
Short	peek(int i)	Deprecated. Please use the corresponding type-specific method instead.
short	peekShort(int i)	Peeks at an element on the stack (optional operation).
Short	pop()	Deprecated. Please use the corresponding type-specific method instead.
short	popShort()	Pops the top off the stack.
void	push(short o)	Pushes the given object on the stack.
void	push(Short o)	Deprecated. Please use the corresponding type-specific method instead.
boolean	rem(short k)	Removes a single instance of the specified element from this collection, if it is present (optional operation).
Short	remove(long index)	Deprecated. Please use the corresponding type-specific method instead.
void	removeElements(long from, long to)	Removes (hopefully quickly) elements of this type-specific big list.
short	removeShort(long i)	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).
Short	set(long index, Short ok)	Deprecated. Please use the corresponding type-specific method instead.
void	setElements(long index, short[][] a, long offset, long length)	Set (hopefully quickly) elements to match the array given.
int	size()	Deprecated. Please use Size64.size64() instead.
void	size(long size)	Sets the size 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.
Short	top()	Deprecated. Please use the corresponding type-specific method instead.
short	topShort()	Peeks at the top of the stack (optional operation).
String	toString()

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

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

Methods inherited from class java.util.AbstractCollection

isEmpty, toArray, toArray

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

containsAll, isEmpty, removeAll, retainAll, toArray, toArray, toArray

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

addAll, addAll, addAll, addAll, getElements, getShort, setElements, setElements, spliterator

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

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

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

forEach, forEach

Methods inherited from interface it.unimi.dsi.fastutil.Size64

size64

Methods inherited from interface it.unimi.dsi.fastutil.Stack

isEmpty

Method Details

add

public void add(long index,
 short k)

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

Specified by:

add in interface ShortBigList

See Also:

• BigList.add(long,Object)

Implementation Specification:

This implementation always throws an UnsupportedOperationException.

add

public boolean add(short k)

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

Specified by:

add in interface ShortCollection

Overrides:

add in class AbstractShortCollection

See Also:

• Collection.add(Object)

Implementation Specification:

This implementation delegates to the type-specific version of BigList.add(long, Object).

removeShort

public short removeShort(long i)

Removes the element at the specified position.

Specified by:

removeShort in interface ShortBigList

See Also:

• BigList.remove(long)

Implementation Specification:

This implementation always throws an UnsupportedOperationException.

set

public short set(long index,
 short k)

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

Specified by:

set in interface ShortBigList

See Also:

• BigList.set(long,Object)

Implementation Specification:

This implementation always throws an UnsupportedOperationException.

addAll

public boolean addAll(long index,
 Collection<? extends Short> c)

Adds all of the elements in the specified collection to this list (optional operation).

Specified by:

addAll in interface BigList<Short>

Parameters:

index - index at which to insert the first element from the specified collection.

c - collection containing elements to be added to this big list.

Returns:

true if this big list changed as a result of the call

See Also:

• List.addAll(int, Collection)

addAll

public boolean addAll(Collection<? extends Short> c)

Specified by:

addAll in interface Collection<Short>

Overrides:

addAll in class AbstractShortCollection

Implementation Specification:

This implementation delegates to the type-specific version of BigList.addAll(long, Collection).

iterator

public ShortBigListIterator iterator()

Returns a type-specific iterator on the elements of this collection.

Specified by:

iterator in interface Collection<Short>

Specified by:

iterator in interface Iterable<Short>

Specified by:

iterator in interface ShortBigList

Specified by:

iterator in interface ShortCollection

Specified by:

iterator in interface ShortIterable

Specified by:

iterator in class AbstractShortCollection

Returns:

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

See Also:

• Iterable.iterator()

Implementation Specification:

This implementation delegates to listIterator().

listIterator

public ShortBigListIterator listIterator()

Returns a type-specific big-list iterator on this type-specific big list.

Specified by:

listIterator in interface BigList<Short>

Specified by:

listIterator in interface ShortBigList

Returns:

a big-list iterator over the elements in this big list.

See Also:

• BigList.listIterator()

Implementation Specification:

This implementation delegates to listIterator(0).

listIterator

public ShortBigListIterator listIterator(long index)

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

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)

Implementation Specification:

This implementation is based on the random-access methods.

intSpliterator

public IntSpliterator intSpliterator()

Description copied from interface: ShortCollection

Returns widened primitive spliterator on the elements of this collection.

This method is provided for the purpose of APIs that expect only the JDK's primitive spliterators, of which there are only int, long, and double.

Specified by:

intSpliterator in interface ShortCollection

Specified by:

intSpliterator in interface ShortIterable

Returns:

a widened primitive spliterator on the elements of this collection.

contains

public boolean contains(short k)

Returns true if this list contains the specified element.

Specified by:

contains in interface ShortCollection

Overrides:

contains in class AbstractShortCollection

See Also:

• Collection.contains(Object)

Implementation Specification:

This implementation delegates to indexOf().

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

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

See Also:

• BigList.lastIndexOf(Object)

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>

Parameters:

size - the new size.

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

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)

forEach

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

Specified by:

forEach in interface ShortIterable

Parameters:

action - the action to be performed for each element.

See Also:

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

Implementation Specification:

If this list is RandomAccess, will iterate using a for loop and the type-specific List.get(int) method. Otherwise it will fallback to using the iterator based loop implementation from the superinterface.

removeElements

public void removeElements(long from,
 long to)

Removes (hopefully quickly) elements of this type-specific big list.

This is a trivial iterator-based implementation. It is expected that implementations will override this method with a more optimized version.

Specified by:

removeElements in interface ShortBigList

Parameters:

from - the start index (inclusive).

to - the end index (exclusive).

addElements

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

Add (hopefully quickly) elements to this type-specific big list.

This is a trivial iterator-based implementation. It is expected that implementations will override this method with a more optimized version.

Specified by:

addElements in interface ShortBigList

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.

addElements

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

Add (hopefully quickly) elements to this type-specific big list.

Specified by:

addElements in interface ShortBigList

Parameters:

index - the index at which to add elements.

a - the big array containing the elements.

Implementation Specification:

This implementation delegates to the analogous method for big-array fragments.

getElements

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

Copies (hopefully quickly) elements of this type-specific big list into the given big array.

This is a trivial iterator-based implementation. It is expected that implementations will override this method with a more optimized version.

Specified by:

getElements in interface ShortBigList

Parameters:

from - the start index (inclusive).

a - the destination big array.

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

length - the number of elements to be copied.

setElements

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

Description copied from interface: ShortBigList

Set (hopefully quickly) elements to match the array given. Sets each in this list to the corresponding elements in the array, as if by

 ListIterator iter = listIterator(index);
 long i = 0;
 while (i < length) {
   iter.next();
   iter.set(BigArrays.get(a, offset + i++);
 }
 

However, the exact implementation may be more efficient, taking into account whether random access is faster or not, or at the discretion of subclasses, abuse internals.

Specified by:

setElements in interface ShortBigList

Parameters:

index - the index at which to start setting elements.

a - the big array containing the elements.

offset - the offset of the first element to add.

length - the number of elements to add.

clear

public void clear()

Specified by:

clear in interface Collection<Short>

Overrides:

clear in class AbstractCollection<Short>

Implementation Specification:

This implementation delegates to removeElements(long, long).

size

@Deprecated
public int size()

Deprecated.

Please use Size64.size64() instead.

Returns the size of this data structure, minimized with Integer.MAX_VALUE.

This default implementation follows the definition above, which is compatible with Collection.size().

Specified by:

size in interface BigList<Short>

Specified by:

size in interface Collection<Short>

Specified by:

size in interface Size64

Specified by:

size in class AbstractCollection<Short>

Returns:

the size of this data structure, minimized with Integer.MAX_VALUE.

See Also:

• Collection.size()

Implementation Specification:

This implementation delegates to Size64.size64().

hashCode

public int hashCode()

Returns the hash code for this big list, which is identical to List.hashCode().

Specified by:

hashCode in interface Collection<Short>

Overrides:

hashCode in class Object

Returns:

the hash code for this big list.

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<Short>

Overrides:

equals in class Object

compareTo

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

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

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.

Throws:

ClassCastException - if the argument is not a big list.

push

public void push(short o)

Description copied from interface: ShortStack

Pushes the given object on the stack.

Specified by:

push in interface ShortStack

Parameters:

o - the object to push on the stack.

See Also:

• Stack.push(Object)

popShort

public short popShort()

Description copied from interface: ShortStack

Pops the top off the stack.

Specified by:

popShort in interface ShortStack

Returns:

the top of the stack.

See Also:

• Stack.pop()

topShort

public short topShort()

Description copied from interface: ShortStack

Peeks at the top of the stack (optional operation).

Specified by:

topShort in interface ShortStack

Returns:

the top of the stack.

See Also:

• Stack.top()

peekShort

public short peekShort(int i)

Description copied from interface: ShortStack

Peeks at an element on the stack (optional operation).

Specified by:

peekShort in interface ShortStack

Parameters:

i - an index from the stop of the stack (0 represents the top).

Returns:

the i-th element on the stack.

See Also:

• Stack.peek(int)

rem

public boolean rem(short k)

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 AbstractShortCollection

See Also:

• Collection.remove(Object)

Implementation Specification:

This implementation delegates to indexOf().

addAll

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

Specified by:

addAll in interface ShortBigList

See Also:

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

Implementation Specification:

This implementation delegates to the type-specific version of addAll(long, Collection).

addAll

public boolean addAll(ShortCollection c)

Adds all elements of the given type-specific collection to this collection.

Specified by:

addAll in interface ShortCollection

Overrides:

addAll in class AbstractShortCollection

Parameters:

c - a type-specific collection.

Returns:

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

See Also:

• Collection.addAll(Collection)

Implementation Specification:

This implementation delegates to the type-specific version of addAll(long, Collection).

add

@Deprecated
public void add(long index,
 Short ok)

Deprecated.

Please use the corresponding type-specific method instead.

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

Specified by:

add in interface BigList<Short>

Specified by:

add in interface ShortBigList

Parameters:

index - a position in the big list.

ok - an element to be inserted.

See Also:

• List.add(int,Object)

Implementation Specification:

This implementation delegates to the corresponding type-specific method.

set

@Deprecated
public Short set(long index,
 Short ok)

Deprecated.

Please use the corresponding type-specific method instead.

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

Specified by:

set in interface BigList<Short>

Specified by:

set in interface ShortBigList

Parameters:

index - a position in the big list.

ok - the element to be stored at the specified position.

Returns:

the element previously at the specified positions.

See Also:

• List.set(int,Object)

Implementation Specification:

This implementation delegates to the corresponding type-specific method.

get

@Deprecated
public Short get(long index)

Deprecated.

Please use the corresponding type-specific method instead.

Returns the element at the specified position.

Specified by:

get in interface BigList<Short>

Specified by:

get in interface ShortBigList

Parameters:

index - a position in the big list.

Returns:

the element at the specified position.

See Also:

• List.get(int)

Implementation Specification:

This implementation delegates to the corresponding type-specific method.

indexOf

@Deprecated
public long indexOf(Object ok)

Deprecated.

Please use the corresponding type-specific method instead.

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

Specified by:

indexOf in interface BigList<Short>

Specified by:

indexOf in interface ShortBigList

Parameters:

ok - the object to search for.

Returns:

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

See Also:

• List.indexOf(Object)

Implementation Specification:

This implementation delegates to the corresponding type-specific method.

lastIndexOf

@Deprecated
public long lastIndexOf(Object ok)

Deprecated.

Please use the corresponding type-specific method instead.

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

Specified by:

lastIndexOf in interface BigList<Short>

Specified by:

lastIndexOf in interface ShortBigList

Parameters:

ok - the object to search for.

Returns:

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

See Also:

• List.lastIndexOf(Object)

Implementation Specification:

This implementation delegates to the corresponding type-specific method.

remove

@Deprecated
public Short remove(long index)

Deprecated.

Please use the corresponding type-specific method instead.

Removes the element at the specified position.

Specified by:

remove in interface BigList<Short>

Specified by:

remove in interface ShortBigList

Parameters:

index - a position in the big list.

Returns:

the element previously at the specified position.

See Also:

• List.remove(int)

Implementation Specification:

This implementation delegates to the corresponding type-specific method.

push

@Deprecated
public void push(Short o)

Deprecated.

Please use the corresponding type-specific method instead.

Pushes the given object on the stack.

This default implementation delegates to the corresponding type-specific method.

Specified by:

push in interface ShortStack

Specified by:

push in interface Stack<Short>

Parameters:

o - the object that will become the new top of the stack.

Implementation Specification:

This implementation delegates to the corresponding type-specific method.

pop

@Deprecated
public Short pop()

Deprecated.

Please use the corresponding type-specific method instead.

Pops the top off the stack.

This default implementation delegates to the corresponding type-specific method.

Specified by:

pop in interface ShortStack

Specified by:

pop in interface Stack<Short>

Returns:

the top of the stack.

Implementation Specification:

This implementation delegates to the corresponding type-specific method.

top

@Deprecated
public Short top()

Deprecated.

Please use the corresponding type-specific method instead.

Peeks at the top of the stack (optional operation).

This default implementation returns peek(0).

This default implementation delegates to the corresponding type-specific method.

Specified by:

top in interface ShortStack

Specified by:

top in interface Stack<Short>

Returns:

the top of the stack.

Implementation Specification:

This implementation delegates to the corresponding type-specific method.

peek

@Deprecated
public Short peek(int i)

Deprecated.

Please use the corresponding type-specific method instead.

Peeks at an element on the stack (optional operation).

This default implementation just throws an UnsupportedOperationException.

This default implementation delegates to the corresponding type-specific method.

Specified by:

peek in interface ShortStack

Specified by:

peek in interface Stack<Short>

Parameters:

i - an index from the stop of the stack (0 represents the top).

Returns:

the i-th element on the stack.

Implementation Specification:

This implementation delegates to the corresponding type-specific method.

toString

public String toString()

Overrides:

toString in class AbstractShortCollection