it.unimi.dsi.fastutil.shorts

Class ShortArrayList

java.lang.Object

java.util.AbstractCollection<Short>

it.unimi.dsi.fastutil.shorts.AbstractShortCollection

it.unimi.dsi.fastutil.shorts.AbstractShortList

it.unimi.dsi.fastutil.shorts.ShortArrayList

All Implemented Interfaces:

ShortCollection, ShortIterable, ShortList, ShortStack, Stack<Short>, Serializable, Cloneable, Comparable<List<? extends Short>>, Iterable<Short>, Collection<Short>, List<Short>, RandomAccess

public class ShortArrayList
extends AbstractShortList
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 dividing the current length by the golden ratio), 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.shorts.AbstractShortList

AbstractShortList.ShortSubList

Field Summary

Fields

Modifier and Type	Field and Description
protected short[]	a The backing array.
static int	DEFAULT_INITIAL_CAPACITY The initial default capacity of an array list.
protected static long	ONEOVERPHI The inverse of the golden ratio times 216.
static long	serialVersionUID
protected int	size The current actual size of the list (never greater than the backing-array length).

Constructor Summary

Constructors

Modifier	Constructor and Description
	ShortArrayList() Creates a new array list with DEFAULT_INITIAL_CAPACITY capacity.
	ShortArrayList(Collection<? extends Short> c) Creates a new array list and fills it with a given collection.
	ShortArrayList(int capacity) Creates a new array list with given capacity.
	ShortArrayList(Iterator<? extends Short> i) Creates a new array list and fills it with the elements returned by an iterator..
	ShortArrayList(short[] a) Creates a new array list and fills it with the elements of a given array.
protected	ShortArrayList(short[] a, boolean dummy) Creates a new array list using a given array.
	ShortArrayList(short[] a, int offset, int length) Creates a new array list and fills it with the elements of a given array.
	ShortArrayList(ShortCollection c) Creates a new array list and fills it with a given type-specific collection.
	ShortArrayList(ShortIterator i) Creates a new array list and fills it with the elements returned by a type-specific iterator..
	ShortArrayList(ShortList l) Creates a new array list and fills it with a given type-specific list.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(int index, short k)
boolean	add(short k)
boolean	addAll(int index, ShortCollection c) Delegates to a more generic method.
boolean	addAll(int index, ShortList l) Delegates to a more generic method.
void	addElements(int index, short[] a, int offset, int length) Adds elements to this type-specific list using optimized system calls.
void	clear()
ShortArrayList	clone()
int	compareTo(ShortArrayList l) Compares this array list to another array list.
short[]	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(ShortArrayList l) Compares this type-specific array list to another one.
void	getElements(int from, short[] a, int offset, int length) Copies element of this type-specific list into the given array using optimized system calls.
short	getShort(int index)
int	indexOf(short k)
boolean	isEmpty() Checks whether the stack is empty.
int	lastIndexOf(short k)
ShortListIterator	listIterator(int index) Returns a type-specific list iterator on the list starting at a given index.
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.
void	removeElements(int from, int to) Removes elements of this type-specific list using optimized system calls.
short	removeShort(int index)
short	set(int index, short k)
int	size()
void	size(int size) Sets the size of this list.
short[]	toShortArray(short[] a) Returns a primitive type array containing the items of this collection.
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.
static ShortArrayList	wrap(short[] a) Wraps a given array into an array list.
static ShortArrayList	wrap(short[] a, int length) Wraps a given array into an array list of given size.

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

add, addAll, addAll, addAll, addAll, addElements, compareTo, contains, ensureIndex, ensureRestrictedIndex, equals, get, hashCode, indexOf, iterator, lastIndexOf, listIterator, peek, peekShort, pop, popShort, push, push, remove, remove, set, shortListIterator, shortListIterator, shortSubList, subList, top, topShort, toString

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

add, contains, containsAll, removeAll, retainAll, toArray, toArray

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

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

DEFAULT_INITIAL_CAPACITY

public static final int DEFAULT_INITIAL_CAPACITY

The initial default capacity of an array list.

See Also:

Constant Field Values

ONEOVERPHI

protected static final long ONEOVERPHI

The inverse of the golden ratio times 2¹⁶.

See Also:

Constant Field Values

a

protected transient short[] a

The backing array.

size

protected int size

The current actual size of the list (never greater than the backing-array length).

Constructor Detail

ShortArrayList

protected ShortArrayList(short[] a,
              boolean dummy)

Creates a new array list using a given array.

This constructor is only meant to be used by the wrapping methods.

Parameters:

a - the array that will be used to back this array list.

ShortArrayList

public ShortArrayList(int capacity)

Creates a new array list with given capacity.

Parameters:

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

ShortArrayList

public ShortArrayList()

Creates a new array list with DEFAULT_INITIAL_CAPACITY capacity.

ShortArrayList

public ShortArrayList(Collection<? extends Short> 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.

ShortArrayList

public ShortArrayList(ShortCollection 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.

ShortArrayList

public ShortArrayList(ShortList 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.

ShortArrayList

public ShortArrayList(short[] 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.

ShortArrayList

public ShortArrayList(short[] 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.

ShortArrayList

public ShortArrayList(Iterator<? extends Short> 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.

ShortArrayList

public ShortArrayList(ShortIterator i)

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

Parameters:

i - a type-specific iterator whose returned elements will fill the array list.

Method Detail

elements

public short[] elements()

Returns the backing array of this list.

Returns:

the backing array.

wrap

public static ShortArrayList wrap(short[] a,
                  int length)

Wraps a given array into an array list of given size.

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 ShortArrayList wrap(short[] a)

Wraps a given array into an array list.

Parameters:

a - an array to wrap.

Returns:

a new array list wrapping the given array.

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,
       short k)

Specified by:

add in interface ShortList

Overrides:

add in class AbstractShortList

See Also:

List.add(int,Object)

add

public boolean add(short k)

Specified by:

add in interface ShortCollection

Specified by:

add in interface ShortList

Overrides:

add in class AbstractShortList

See Also:

Collection.add(Object)

getShort

public short getShort(int index)

Specified by:

getShort in interface ShortList

See Also:

List.get(int)

indexOf

public int indexOf(short k)

Specified by:

indexOf in interface ShortList

Overrides:

indexOf in class AbstractShortList

See Also:

List.indexOf(Object)

lastIndexOf

public int lastIndexOf(short k)

Specified by:

lastIndexOf in interface ShortList

Overrides:

lastIndexOf in class AbstractShortList

See Also:

List.lastIndexOf(Object)

removeShort

public short removeShort(int index)

Specified by:

removeShort in interface ShortList

Overrides:

removeShort in class AbstractShortList

See Also:

List.remove(int)

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 AbstractShortList

See Also:

Collection.remove(Object)

set

public short set(int index,
        short k)

Specified by:

set in interface ShortList

Overrides:

set in class AbstractShortList

See Also:

List.set(int,Object)

clear

public void clear()

Specified by:

clear in interface Collection<Short>

Specified by:

clear in interface List<Short>

Overrides:

clear in class AbstractCollection<Short>

size

public int size()

Specified by:

size in interface Collection<Short>

Specified by:

size in interface List<Short>

Specified by:

size in class AbstractCollection<Short>

size

public void size(int size)

Description copied from interface: ShortList

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 ShortList

Overrides:

size in class AbstractShortList

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

Specified by:

isEmpty in interface Collection<Short>

Specified by:

isEmpty in interface List<Short>

Overrides:

isEmpty in class AbstractShortCollection

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.

getElements

public void getElements(int 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 ShortList

Overrides:

getElements in class AbstractShortList

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 ShortList

Overrides:

removeElements in class AbstractShortList

Parameters:

from - the start index (inclusive).

to - the end index (exclusive).

addElements

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

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

Specified by:

addElements in interface ShortList

Overrides:

addElements in class AbstractShortList

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.

toShortArray

public short[] toShortArray(short[] a)

Description copied from interface: ShortCollection

Returns a primitive type array containing the items of this collection.

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:

toShortArray in interface ShortCollection

Overrides:

toShortArray in class AbstractShortCollection

Parameters:

a - if this array is big enough, it will be used to store this collection.

Returns:

a primitive type array containing the items of this collection.

See Also:

Collection.toArray(Object[])

addAll

public boolean addAll(int index,
             ShortCollection c)

Description copied from class: AbstractShortList

Delegates to a more generic method.

Specified by:

addAll in interface ShortList

Overrides:

addAll in class AbstractShortList

See Also:

List.add(int,Object)

addAll

public boolean addAll(int index,
             ShortList l)

Description copied from class: AbstractShortList

Delegates to a more generic method.

Specified by:

addAll in interface ShortList

Overrides:

addAll in class AbstractShortList

See Also:

List.add(int,Object)

listIterator

public ShortListIterator listIterator(int index)

Description copied from interface: ShortList

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

Specified by:

listIterator in interface ShortList

Specified by:

listIterator in interface List<Short>

Overrides:

listIterator in class AbstractShortList

See Also:

List.listIterator(int)

clone

public ShortArrayList clone()

Overrides:

clone in class Object

equals

public boolean equals(ShortArrayList l)

Compares this type-specific array list to another one.

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

Parameters:

l - a type-specific array list.

Returns:

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

compareTo

public int compareTo(ShortArrayList l)

Compares this array list to another array list.

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

Parameters:

l - an array list.

Returns:

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