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

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractShortBigList.ShortSubList

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractShortBigList()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(long index, short k)
void	add(long index, Short ok) Delegates to the corresponding type-specific method.
boolean	add(short k)
boolean	addAll(Collection<? extends Short> c) Delegates to a more generic method.
boolean	addAll(int index, Collection<? extends Short> c)
boolean	addAll(long index, Collection<? extends Short> c) Inserts all of the elements in the specified collection into this big list at the specified position (optional operation).
boolean	addAll(long index, ShortBigList l) Delegates to a more generic method.
boolean	addAll(long index, ShortCollection c) Delegates to a more generic method.
boolean	addAll(ShortBigList l)
boolean	addAll(ShortCollection c) Adds all elements of the given type-specific collection to this collection.
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) Adds elements to this type-specific big list one-by-one.
int	compareTo(BigList<? extends Short> l) Compares this big list to another object.
boolean	contains(short k)
protected void	ensureIndex(long index) Ensures that the given index is nonnegative and not greater than this big-list size.
protected void	ensureRestrictedIndex(long index) Ensures that the given index is nonnegative and smaller than this big-list size.
boolean	equals(Object o)
Short	get(long index) Delegates to the corresponding type-specific method.
void	getElements(long from, short[][] a, long offset, long length) Copies element of this type-specific big list into the given big array one-by-one.
short	getShort(int index)
int	hashCode() Returns the hash code for this big list, which is identical to List.hashCode().
long	indexOf(Object ok) Delegates to the corresponding type-specific method.
long	indexOf(short k)
ShortBigListIterator	iterator() Returns a type-specific iterator on the elements of this collection.
long	lastIndexOf(Object ok) Delegates to the corresponding type-specific method.
long	lastIndexOf(short k)
ShortBigListIterator	listIterator() Returns a type-specific big-list iterator on this type-specific big list.
ShortBigListIterator	listIterator(int index)
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) Delegates to the corresponding type-specific method.
short	peekShort(int i)
Short	pop() Delegates to the corresponding type-specific method.
short	popShort()
void	push(short o)
void	push(Short o) Delegates to the corresponding type-specific method.
boolean	rem(short k) Note that this method should be called remove(), but the clash with the similarly named index-based method in the List interface forces us to use a distinguished name.
Short	remove(int index) Delegates to the corresponding type-specific method.
Short	remove(long index) Delegates to the corresponding type-specific method.
void	removeElements(long from, long to) Removes elements of this type-specific big list one-by-one.
short	removeShort(int i)
short	removeShort(long i)
short	set(int index, short k)
short	set(long index, short k)
Short	set(long index, Short ok) Delegates to the corresponding type-specific method.
int	size() Deprecated.
void	size(int size)
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() Delegates to the corresponding type-specific method.
short	topShort()
String	toString()

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

add, contains, containsAll, containsAll, isEmpty, rem, remove, removeAll, removeAll, retainAll, retainAll, shortIterator, toArray, toArray, toArray, toShortArray, toShortArray

Methods inherited from class java.util.AbstractCollection

clear

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getShort

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

size64

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

containsAll, removeAll, retainAll, shortIterator, toArray, toArray, toShortArray, toShortArray

Methods inherited from interface java.util.Collection

add, clear, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray

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

isEmpty

Constructor Detail

AbstractShortBigList

protected AbstractShortBigList()

Method Detail

ensureIndex

protected void ensureIndex(long index)

Ensures that the given index is nonnegative and not greater than this big-list size.

Parameters:

index - an index.

Throws:

IndexOutOfBoundsException - if the given index is negative or greater than this big-list size.

ensureRestrictedIndex

protected void ensureRestrictedIndex(long index)

Ensures that the given index is nonnegative and smaller than this big-list size.

Parameters:

index - an index.

Throws:

IndexOutOfBoundsException - if the given index is negative or not smaller than this big-list size.

add

public void add(long index,
       short k)

Specified by:

add in interface ShortBigList

See Also:

List.add(int,Object)

add

public boolean add(short k)

Specified by:

add in interface ShortCollection

Overrides:

add in class AbstractShortCollection

See Also:

Collection.add(Object)

removeShort

public short removeShort(long i)

Specified by:

removeShort in interface ShortBigList

See Also:

BigList.remove(long)

removeShort

public short removeShort(int i)

set

public short set(long index,
        short k)

Specified by:

set in interface ShortBigList

See Also:

BigList.set(long,Object)

set

public short set(int index,
        short k)

addAll

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

Description copied from interface: BigList

Inserts all of the elements in the specified collection into this big list at the specified position (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(int index,
             Collection<? extends Short> c)

addAll

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

Delegates to a more generic method.

Specified by:

addAll in interface Collection<Short>

Overrides:

addAll in class AbstractShortCollection

Parameters:

c - a collection.

Returns:

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

iterator

public ShortBigListIterator iterator()

Description copied from interface: ShortCollection

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

Note that this specification strengthens the one given in Iterable.iterator(), which was already strengthened in the corresponding type-specific class, but was weakened by the fact that this interface extends Collection.

Specified by:

iterator in interface ShortBigList

Specified by:

iterator in interface ShortCollection

Specified by:

iterator in interface ShortIterable

Specified by:

iterator in interface Iterable<Short>

Specified by:

iterator in interface Collection<Short>

Specified by:

iterator in class AbstractShortCollection

Returns:

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

See Also:

List.iterator()

listIterator

public ShortBigListIterator listIterator()

Description copied from interface: ShortBigList

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:

List.listIterator()

listIterator

public ShortBigListIterator listIterator(long index)

Description copied from interface: ShortBigList

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)

listIterator

public ShortBigListIterator listIterator(int index)

contains

public boolean contains(short k)

Specified by:

contains in interface ShortCollection

Overrides:

contains in class AbstractShortCollection

See Also:

Collection.contains(Object)

indexOf

public long indexOf(short k)

Specified by:

indexOf in interface ShortBigList

See Also:

BigList.indexOf(Object)

lastIndexOf

public long lastIndexOf(short k)

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.

size

public void size(int 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.

Note that this specification strengthens the one given in BigList.subList(long,long).

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)

removeElements

public void removeElements(long from,
                  long to)

Removes elements of this type-specific big list one-by-one.

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)

Adds elements to this type-specific big list one-by-one.

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)

Description copied from interface: ShortBigList

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.

getElements

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

Copies element of this type-specific big list into the given big array one-by-one.

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.

size

@Deprecated
public int size()

Deprecated.

Description copied from interface: Size64

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

Specified by:

size in interface Size64

Specified by:

size in interface Collection<Short>

Specified by:

size in class AbstractCollection<Short>

Returns:

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

See Also:

Collection.size()

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.

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.

push

public void push(short o)

Specified by:

push in interface ShortStack

See Also:

Stack.push(Object)

popShort

public short popShort()

Specified by:

popShort in interface ShortStack

See Also:

Stack.pop()

topShort

public short topShort()

Specified by:

topShort in interface ShortStack

See Also:

Stack.top()

peekShort

public short peekShort(int i)

Specified by:

peekShort in interface ShortStack

See Also:

Stack.peek(int)

getShort

public short getShort(int index)

rem

public boolean rem(short k)

Description copied from interface: ShortCollection

Note that this method should be called remove(), but the clash with the similarly named index-based method in the List interface forces us to use a distinguished name. For simplicity, the set interfaces reinstates remove().

Specified by:

rem in interface ShortCollection

Overrides:

rem in class AbstractShortCollection

See Also:

Collection.remove(Object)

addAll

public boolean addAll(long index,
             ShortCollection c)

Delegates to a more generic method.

Specified by:

addAll in interface ShortBigList

See Also:

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

addAll

public boolean addAll(long index,
             ShortBigList l)

Delegates to a more generic method.

Specified by:

addAll in interface ShortBigList

See Also:

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

addAll

public boolean addAll(ShortCollection c)

Description copied from class: AbstractShortCollection

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)

addAll

public boolean addAll(ShortBigList l)

Specified by:

addAll in interface ShortBigList

See Also:

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

add

public void add(long index,
       Short ok)

Delegates to the corresponding type-specific method.

Specified by:

add in interface BigList<Short>

Parameters:

index - a position in the big list.

ok - an element to be inserted.

See Also:

List.add(int,Object)

set

public Short set(long index,
        Short ok)

Delegates to the corresponding type-specific method.

Specified by:

set in interface BigList<Short>

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)

get

public Short get(long index)

Delegates to the corresponding type-specific method.

Specified by:

get in interface BigList<Short>

Parameters:

index - a position in the big list.

Returns:

the element at the specified position.

See Also:

List.get(int)

indexOf

public long indexOf(Object ok)

Delegates to the corresponding type-specific method.

Specified by:

indexOf in interface BigList<Short>

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)

lastIndexOf

public long lastIndexOf(Object ok)

Delegates to the corresponding type-specific method.

Specified by:

lastIndexOf in interface BigList<Short>

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)

remove

public Short remove(int index)

Delegates to the corresponding type-specific method.

remove

public Short remove(long index)

Delegates to the corresponding type-specific method.

Specified by:

remove in interface BigList<Short>

Parameters:

index - a position in the big list.

Returns:

the element previously at the specified position.

See Also:

List.remove(int)

push

public void push(Short o)

Delegates to the corresponding type-specific method.

Specified by:

push in interface Stack<Short>

Parameters:

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

pop

public Short pop()

Delegates to the corresponding type-specific method.

Specified by:

pop in interface Stack<Short>

Returns:

the top of the stack.

top

public Short top()

Delegates to the corresponding type-specific method.

Specified by:

top in interface Stack<Short>

Returns:

the top of the stack.

peek

public Short peek(int i)

Delegates to the corresponding type-specific method.

Specified by:

peek in interface Stack<Short>

Returns:

the i-th element on the stack; 0 represents the top.

toString

public String toString()

Overrides:

toString in class AbstractShortCollection