it.unimi.dsi.fastutil.ints

Class AbstractIntList

java.lang.Object

java.util.AbstractCollection<java.lang.Integer>

it.unimi.dsi.fastutil.ints.AbstractIntCollection

it.unimi.dsi.fastutil.ints.AbstractIntList

All Implemented Interfaces:

IntCollection, IntIterable, IntList, IntStack, Stack<java.lang.Integer>, java.lang.Comparable<java.util.List<? extends java.lang.Integer>>, java.lang.Iterable<java.lang.Integer>, java.util.Collection<java.lang.Integer>, java.util.List<java.lang.Integer>

Direct Known Subclasses:

AbstractIntList.IntSubList, IntArrayList

public abstract class AbstractIntList
extends AbstractIntCollection
implements IntList, IntStack

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

As an additional bonus, this class implements on top of the list operations a type-specific stack.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractIntList.IntSubList

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractIntList()

Method Summary

Modifier and Type	Method and Description
boolean	add(int k)
void	add(int index, int k)
void	add(int index, java.lang.Integer ok) Delegates to the corresponding type-specific method.
boolean	addAll(java.util.Collection<? extends java.lang.Integer> c) Delegates to a more generic method.
boolean	addAll(IntCollection c) Adds all elements of the given type-specific collection to this collection.
boolean	addAll(int index, java.util.Collection<? extends java.lang.Integer> c)
boolean	addAll(int index, IntCollection c) Delegates to a more generic method.
boolean	addAll(int index, IntList l) Delegates to a more generic method.
boolean	addAll(IntList l)
void	addElements(int index, int[] a) Add (hopefully quickly) elements to this type-specific list.
void	addElements(int index, int[] a, int offset, int length) Adds elements to this type-specific list one-by-one.
int	compareTo(java.util.List<? extends java.lang.Integer> l) Compares this list to another object.
boolean	contains(int k)
protected void	ensureIndex(int index) Ensures that the given index is nonnegative and not greater than the list size.
protected void	ensureRestrictedIndex(int index) Ensures that the given index is nonnegative and smaller than the list size.
boolean	equals(java.lang.Object o)
java.lang.Integer	get(int index) Deprecated. Please use the corresponding type-specific method instead.
void	getElements(int from, int[] a, int offset, int length) Copies element of this type-specific list into the given array one-by-one.
int	hashCode() Returns the hash code for this list, which is identical to List.hashCode().
int	indexOf(int k)
int	indexOf(java.lang.Object ok) Delegates to the corresponding type-specific method.
IntListIterator	intListIterator() Deprecated.
IntListIterator	intListIterator(int index) Deprecated.
IntList	intSubList(int from, int to) Deprecated.
IntListIterator	iterator() Returns a type-specific iterator on the elements of this collection.
int	lastIndexOf(int k)
int	lastIndexOf(java.lang.Object ok) Delegates to the corresponding type-specific method.
IntListIterator	listIterator() Returns a type-specific list iterator on the list.
IntListIterator	listIterator(int index) Returns a type-specific list iterator on the list starting at a given index.
java.lang.Integer	peek(int i) Deprecated. Please use the corresponding type-specific method instead.
int	peekInt(int i)
java.lang.Integer	pop() Deprecated. Please use the corresponding type-specific method instead.
int	popInt()
void	push(int o)
void	push(java.lang.Integer o) Delegates to the corresponding type-specific method.
boolean	rem(int 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.
java.lang.Integer	remove(int index) Deprecated. Please use the corresponding type-specific method instead.
boolean	remove(java.lang.Object o) Delegates to rem().
void	removeElements(int from, int to) Removes elements of this type-specific list one-by-one.
int	removeInt(int i)
int	set(int index, int k)
java.lang.Integer	set(int index, java.lang.Integer ok) Deprecated. Please use the corresponding type-specific method instead.
void	size(int size) Sets the size of this list.
IntList	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.
java.lang.Integer	top() Deprecated. Please use the corresponding type-specific method instead.
int	topInt()
java.lang.String	toString()

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractIntCollection

add, contains, containsAll, containsAll, intIterator, isEmpty, rem, removeAll, removeAll, retainAll, retainAll, toArray, toArray, toArray, toIntArray, toIntArray

Methods inherited from class java.util.AbstractCollection

clear, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface it.unimi.dsi.fastutil.ints.IntList

getInt

Methods inherited from interface java.util.List

add, clear, contains, containsAll, isEmpty, removeAll, replaceAll, retainAll, size, sort, spliterator, toArray, toArray

Methods inherited from interface it.unimi.dsi.fastutil.ints.IntCollection

containsAll, intIterator, removeAll, retainAll, toArray, toArray, toIntArray, toIntArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

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

isEmpty

Constructor Detail

AbstractIntList

protected AbstractIntList()

Method Detail

ensureIndex

protected void ensureIndex(int index)

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

Parameters:

index - an index.

Throws:

java.lang.IndexOutOfBoundsException - if the given index is negative or greater than the list size.

ensureRestrictedIndex

protected void ensureRestrictedIndex(int index)

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

Parameters:

index - an index.

Throws:

java.lang.IndexOutOfBoundsException - if the given index is negative or not smaller than the list size.

add

public void add(int index,
                int k)

Specified by:

add in interface IntList

See Also:

List.add(int,Object)

add

public boolean add(int k)

Specified by:

add in interface IntCollection

Specified by:

add in interface IntList

Overrides:

add in class AbstractIntCollection

See Also:

Collection.add(Object)

removeInt

public int removeInt(int i)

Specified by:

removeInt in interface IntList

See Also:

List.remove(int)

set

public int set(int index,
               int k)

Specified by:

set in interface IntList

See Also:

List.set(int,Object)

addAll

public boolean addAll(int index,
                      java.util.Collection<? extends java.lang.Integer> c)

Specified by:

addAll in interface java.util.List<java.lang.Integer>

addAll

public boolean addAll(java.util.Collection<? extends java.lang.Integer> c)

Delegates to a more generic method.

Specified by:

addAll in interface java.util.Collection<java.lang.Integer>

Specified by:

addAll in interface java.util.List<java.lang.Integer>

Overrides:

addAll in class AbstractIntCollection

Parameters:

c - a collection.

Returns:

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

intListIterator

@Deprecated
public IntListIterator intListIterator()

Deprecated.

Delegates to the new covariantly stronger generic method.

Specified by:

intListIterator in interface IntList

See Also:

IntList.listIterator()

intListIterator

@Deprecated
public IntListIterator intListIterator(int index)

Deprecated.

Delegates to the new covariantly stronger generic method.

Specified by:

intListIterator in interface IntList

See Also:

IntList.listIterator(int)

iterator

public IntListIterator iterator()

Description copied from interface: IntCollection

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 IntCollection

Specified by:

iterator in interface IntIterable

Specified by:

iterator in interface IntList

Specified by:

iterator in interface java.lang.Iterable<java.lang.Integer>

Specified by:

iterator in interface java.util.Collection<java.lang.Integer>

Specified by:

iterator in interface java.util.List<java.lang.Integer>

Specified by:

iterator in class AbstractIntCollection

Returns:

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

listIterator

public IntListIterator listIterator()

Description copied from interface: IntList

Returns a type-specific list iterator on the list.

Specified by:

listIterator in interface IntList

Specified by:

listIterator in interface java.util.List<java.lang.Integer>

See Also:

List.listIterator()

listIterator

public IntListIterator listIterator(int index)

Description copied from interface: IntList

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

Specified by:

listIterator in interface IntList

Specified by:

listIterator in interface java.util.List<java.lang.Integer>

See Also:

List.listIterator(int)

contains

public boolean contains(int k)

Specified by:

contains in interface IntCollection

Overrides:

contains in class AbstractIntCollection

See Also:

Collection.contains(Object)

indexOf

public int indexOf(int k)

Specified by:

indexOf in interface IntList

See Also:

List.indexOf(Object)

lastIndexOf

public int lastIndexOf(int k)

Specified by:

lastIndexOf in interface IntList

See Also:

List.lastIndexOf(Object)

size

public void size(int size)

Description copied from interface: IntList

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 IntList

Parameters:

size - the new size.

subList

public IntList subList(int from,
                       int to)

Description copied from interface: IntList

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

Note that this specification strengthens the one given in List.subList(int,int).

Specified by:

subList in interface IntList

Specified by:

subList in interface java.util.List<java.lang.Integer>

See Also:

List.subList(int,int)

intSubList

@Deprecated
public IntList intSubList(int from,
                                      int to)

Deprecated.

Delegates to the new covariantly stronger generic method.

Specified by:

intSubList in interface IntList

See Also:

List.subList(int,int)

removeElements

public void removeElements(int from,
                           int to)

Removes elements of this type-specific 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 IntList

Parameters:

from - the start index (inclusive).

to - the end index (exclusive).

addElements

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

Adds elements to this type-specific 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 IntList

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.

addElements

public void addElements(int index,
                        int[] a)

Description copied from interface: IntList

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

Specified by:

addElements in interface IntList

Parameters:

index - the index at which to add elements.

a - the array containing the elements.

getElements

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

Copies element of this type-specific list into the given 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 IntList

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.

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface java.util.Collection<java.lang.Integer>

Specified by:

equals in interface java.util.List<java.lang.Integer>

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(java.util.List<? extends java.lang.Integer> l)

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 java.lang.Comparable<java.util.List<? extends java.lang.Integer>>

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.

Throws:

java.lang.ClassCastException - if the argument is not a list.

hashCode

public int hashCode()

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

Specified by:

hashCode in interface java.util.Collection<java.lang.Integer>

Specified by:

hashCode in interface java.util.List<java.lang.Integer>

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code for this list.

push

public void push(int o)

Specified by:

push in interface IntStack

See Also:

Stack.push(Object)

popInt

public int popInt()

Specified by:

popInt in interface IntStack

See Also:

Stack.pop()

topInt

public int topInt()

Specified by:

topInt in interface IntStack

See Also:

Stack.top()

peekInt

public int peekInt(int i)

Specified by:

peekInt in interface IntStack

See Also:

Stack.peek(int)

rem

public boolean rem(int k)

Description copied from interface: IntCollection

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 IntCollection

Overrides:

rem in class AbstractIntCollection

See Also:

Collection.remove(Object)

remove

public boolean remove(java.lang.Object o)

Delegates to rem().

Specified by:

remove in interface java.util.Collection<java.lang.Integer>

Specified by:

remove in interface java.util.List<java.lang.Integer>

Overrides:

remove in class AbstractIntCollection

addAll

public boolean addAll(int index,
                      IntCollection c)

Delegates to a more generic method.

Specified by:

addAll in interface IntList

See Also:

List.add(int,Object)

addAll

public boolean addAll(int index,
                      IntList l)

Delegates to a more generic method.

Specified by:

addAll in interface IntList

See Also:

List.add(int,Object)

addAll

public boolean addAll(IntCollection c)

Description copied from class: AbstractIntCollection

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

Specified by:

addAll in interface IntCollection

Overrides:

addAll in class AbstractIntCollection

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(IntList l)

Specified by:

addAll in interface IntList

See Also:

List.add(int,Object)

add

public void add(int index,
                java.lang.Integer ok)

Delegates to the corresponding type-specific method.

Specified by:

add in interface java.util.List<java.lang.Integer>

set

@Deprecated
public java.lang.Integer set(int index,
                                         java.lang.Integer ok)

Deprecated. Please use the corresponding type-specific method instead.

Delegates to the corresponding type-specific method.

Specified by:

set in interface java.util.List<java.lang.Integer>

get

@Deprecated
public java.lang.Integer get(int index)

Deprecated. Please use the corresponding type-specific method instead.

Delegates to the corresponding type-specific method.

Specified by:

get in interface java.util.List<java.lang.Integer>

indexOf

public int indexOf(java.lang.Object ok)

Delegates to the corresponding type-specific method.

Specified by:

indexOf in interface java.util.List<java.lang.Integer>

lastIndexOf

public int lastIndexOf(java.lang.Object ok)

Delegates to the corresponding type-specific method.

Specified by:

lastIndexOf in interface java.util.List<java.lang.Integer>

remove

@Deprecated
public java.lang.Integer remove(int index)

Deprecated. Please use the corresponding type-specific method instead.

Delegates to the corresponding type-specific method.

Specified by:

remove in interface java.util.List<java.lang.Integer>

push

public void push(java.lang.Integer o)

Delegates to the corresponding type-specific method.

Specified by:

push in interface Stack<java.lang.Integer>

Parameters:

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

pop

@Deprecated
public java.lang.Integer pop()

Deprecated. Please use the corresponding type-specific method instead.

Delegates to the corresponding type-specific method.

Specified by:

pop in interface Stack<java.lang.Integer>

Returns:

the top of the stack.

top

@Deprecated
public java.lang.Integer top()

Deprecated. Please use the corresponding type-specific method instead.

Delegates to the corresponding type-specific method.

Specified by:

top in interface Stack<java.lang.Integer>

Returns:

the top of the stack.

peek

@Deprecated
public java.lang.Integer peek(int i)

Deprecated. Please use the corresponding type-specific method instead.

Delegates to the corresponding type-specific method.

Specified by:

peek in interface Stack<java.lang.Integer>

Parameters:

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

Returns:

the i-th element on the stack.

toString

public java.lang.String toString()

Overrides:

toString in class AbstractIntCollection