it.unimi.dsi.fastutil.ints

Class AbstractIntBigList

java.lang.Object

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

it.unimi.dsi.fastutil.ints.AbstractIntCollection

it.unimi.dsi.fastutil.ints.AbstractIntBigList

All Implemented Interfaces:

it.unimi.dsi.fastutil.BigList<java.lang.Integer>, IntBigList, it.unimi.dsi.fastutil.ints.IntCollection, it.unimi.dsi.fastutil.ints.IntIterable, it.unimi.dsi.fastutil.ints.IntStack, it.unimi.dsi.fastutil.Size64, it.unimi.dsi.fastutil.Stack<java.lang.Integer>, java.lang.Comparable<it.unimi.dsi.fastutil.BigList<? extends java.lang.Integer>>, java.lang.Iterable<java.lang.Integer>, java.util.Collection<java.lang.Integer>

Direct Known Subclasses:

AbstractIntBigList.IntSubList, IntMappedBigList

public abstract class AbstractIntBigList
extends it.unimi.dsi.fastutil.ints.AbstractIntCollection
implements IntBigList, it.unimi.dsi.fastutil.ints.IntStack

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.Integer>)) 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 and Description
static class	AbstractIntBigList.IntRandomAccessSubList
static class	AbstractIntBigList.IntSubList A class implementing a sublist view.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractIntBigList()

Method Summary

Modifier and Type	Method and Description
boolean	add(int k)
void	add(long index, int k) Inserts the specified element at the specified position in this type-specific big list (optional operation).
void	add(long index, java.lang.Integer ok) Deprecated. Please use the corresponding type-specific method instead.
boolean	addAll(java.util.Collection<? extends java.lang.Integer> c)
boolean	addAll(it.unimi.dsi.fastutil.ints.IntCollection c)
boolean	addAll(long index, java.util.Collection<? extends java.lang.Integer> c) Adds all of the elements in the specified collection to this list (optional operation).
boolean	addAll(long index, it.unimi.dsi.fastutil.ints.IntCollection c) Inserts all of the elements in the specified type-specific collection into this type-specific big list at the specified position (optional operation).
void	addElements(long index, int[][] a) Add (hopefully quickly) elements to this type-specific big list.
void	addElements(long index, int[][] a, long offset, long length) Add (hopefully quickly) elements to this type-specific big list.
void	clear()
int	compareTo(it.unimi.dsi.fastutil.BigList<? extends java.lang.Integer> l) Compares this big list to another object.
boolean	contains(int k) Returns true if this list contains the specified element.
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(java.lang.Object o)
void	forEach(java.util.function.IntConsumer action)
java.lang.Integer	get(long index) Deprecated. Please use the corresponding type-specific method instead.
void	getElements(long from, int[][] 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(int 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(java.lang.Object ok) Deprecated. Please use the corresponding type-specific method instead.
it.unimi.dsi.fastutil.ints.IntBigListIterator	iterator() Returns a type-specific iterator on the elements of this list.
long	lastIndexOf(int 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(java.lang.Object ok) Deprecated. Please use the corresponding type-specific method instead.
it.unimi.dsi.fastutil.ints.IntBigListIterator	listIterator() Returns a type-specific big-list iterator on this type-specific big list.
it.unimi.dsi.fastutil.ints.IntBigListIterator	listIterator(long index) Returns a type-specific list iterator on this type-specific big 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) Deprecated. Please use the corresponding type-specific method instead.
boolean	rem(int k) Removes a single instance of the specified element from this collection, if it is present (optional operation).
java.lang.Integer	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.
int	removeInt(long i) Removes the element at the specified position.
int	set(long index, int k) Replaces the element at the specified position in this big list with the specified element (optional operation).
java.lang.Integer	set(long index, java.lang.Integer ok) Deprecated. Please use the corresponding type-specific method instead.
void	setElements(long index, int[][] 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)
IntBigList	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.
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, forEach, remove, removeAll, removeAll, removeIf, retainAll, retainAll, toArray, toIntArray, toIntArray

Methods inherited from class java.util.AbstractCollection

isEmpty, toArray, toArray

Methods inherited from class java.lang.Object

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

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

addAll, addAll, addAll, addAll, getElements, getInt, setElements, setElements, spliterator

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

size64, sizeOf, sizeOf

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

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

Methods inherited from interface java.util.Collection

containsAll, isEmpty, removeAll, retainAll, toArray, toArray

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

forEach, forEach

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

isEmpty

Constructor Detail

AbstractIntBigList

protected AbstractIntBigList()

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:

java.lang.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:

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

add

public void add(long index,
                int k)

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

Specified by:

add in interface IntBigList

See Also:

BigList.add(long,Object)

add

public boolean add(int k)

Specified by:

add in interface it.unimi.dsi.fastutil.ints.IntCollection

Overrides:

add in class it.unimi.dsi.fastutil.ints.AbstractIntCollection

removeInt

public int removeInt(long i)

Removes the element at the specified position.

Specified by:

removeInt in interface IntBigList

See Also:

BigList.remove(long)

set

public int set(long index,
               int k)

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

Specified by:

set in interface IntBigList

See Also:

BigList.set(long,Object)

addAll

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

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

Specified by:

addAll in interface it.unimi.dsi.fastutil.BigList<java.lang.Integer>

addAll

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

Specified by:

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

Overrides:

addAll in class it.unimi.dsi.fastutil.ints.AbstractIntCollection

iterator

public it.unimi.dsi.fastutil.ints.IntBigListIterator iterator()

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

Specified by:

iterator in interface IntBigList

Specified by:

iterator in interface it.unimi.dsi.fastutil.ints.IntCollection

Specified by:

iterator in interface it.unimi.dsi.fastutil.ints.IntIterable

Specified by:

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

Specified by:

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

Overrides:

iterator in class it.unimi.dsi.fastutil.ints.AbstractIntCollection

See Also:

Collection.iterator()

listIterator

public it.unimi.dsi.fastutil.ints.IntBigListIterator listIterator()

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

Specified by:

listIterator in interface it.unimi.dsi.fastutil.BigList<java.lang.Integer>

Specified by:

listIterator in interface IntBigList

See Also:

BigList.listIterator()

listIterator

public it.unimi.dsi.fastutil.ints.IntBigListIterator 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 it.unimi.dsi.fastutil.BigList<java.lang.Integer>

Specified by:

listIterator in interface IntBigList

See Also:

BigList.listIterator(long)

contains

public boolean contains(int k)

Returns true if this list contains the specified element.

Specified by:

contains in interface it.unimi.dsi.fastutil.ints.IntCollection

Overrides:

contains in class it.unimi.dsi.fastutil.ints.AbstractIntCollection

See Also:

Collection.contains(Object)

indexOf

public long indexOf(int k)

Description copied from interface: IntBigList

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 IntBigList

See Also:

BigList.indexOf(Object)

lastIndexOf

public long lastIndexOf(int k)

Description copied from interface: IntBigList

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 IntBigList

See Also:

BigList.lastIndexOf(Object)

size

public void size(long size)

Specified by:

size in interface it.unimi.dsi.fastutil.BigList<java.lang.Integer>

subList

public IntBigList subList(long from,
                          long to)

Description copied from interface: IntBigList

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 it.unimi.dsi.fastutil.BigList<java.lang.Integer>

Specified by:

subList in interface IntBigList

See Also:

BigList.subList(long,long)

forEach

public void forEach(java.util.function.IntConsumer action)

Specified by:

forEach in interface it.unimi.dsi.fastutil.ints.IntIterable

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 IntBigList

Parameters:

from - the start index (inclusive).

to - the end index (exclusive).

addElements

public void addElements(long index,
                        int[][] 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 IntBigList

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,
                        int[][] a)

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

Specified by:

addElements in interface IntBigList

Parameters:

index - the index at which to add elements.

a - the big array containing the elements.

getElements

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

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,
                        int[][] a,
                        long offset,
                        long length)

Description copied from interface: IntBigList

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 IntBigList

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

Overrides:

clear in class java.util.AbstractCollection<java.lang.Integer>

size

@Deprecated
public int size()

Deprecated. Please use Size64.size64() instead.

Specified by:

size in interface it.unimi.dsi.fastutil.BigList<java.lang.Integer>

Specified by:

size in interface it.unimi.dsi.fastutil.Size64

Specified by:

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

Specified by:

size in class java.util.AbstractCollection<java.lang.Integer>

hashCode

public int hashCode()

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

Specified by:

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

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code for this big list.

equals

public boolean equals(java.lang.Object o)

Specified by:

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

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(it.unimi.dsi.fastutil.BigList<? extends java.lang.Integer> 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 java.lang.Comparable<it.unimi.dsi.fastutil.BigList<? extends java.lang.Integer>>

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:

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

push

public void push(int o)

Specified by:

push in interface it.unimi.dsi.fastutil.ints.IntStack

popInt

public int popInt()

Specified by:

popInt in interface it.unimi.dsi.fastutil.ints.IntStack

topInt

public int topInt()

Specified by:

topInt in interface it.unimi.dsi.fastutil.ints.IntStack

peekInt

public int peekInt(int i)

Specified by:

peekInt in interface it.unimi.dsi.fastutil.ints.IntStack

rem

public boolean rem(int k)

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

Specified by:

rem in interface it.unimi.dsi.fastutil.ints.IntCollection

Overrides:

rem in class it.unimi.dsi.fastutil.ints.AbstractIntCollection

See Also:

Collection.remove(Object)

addAll

public boolean addAll(long index,
                      it.unimi.dsi.fastutil.ints.IntCollection 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 IntBigList

See Also:

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

addAll

public boolean addAll(it.unimi.dsi.fastutil.ints.IntCollection c)

Specified by:

addAll in interface it.unimi.dsi.fastutil.ints.IntCollection

Overrides:

addAll in class it.unimi.dsi.fastutil.ints.AbstractIntCollection

add

@Deprecated
public void add(long index,
                            java.lang.Integer ok)

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

Specified by:

add in interface it.unimi.dsi.fastutil.BigList<java.lang.Integer>

Specified by:

add in interface IntBigList

set

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

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

Specified by:

set in interface it.unimi.dsi.fastutil.BigList<java.lang.Integer>

Specified by:

set in interface IntBigList

get

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

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

Specified by:

get in interface it.unimi.dsi.fastutil.BigList<java.lang.Integer>

Specified by:

get in interface IntBigList

indexOf

@Deprecated
public long indexOf(java.lang.Object ok)

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

Specified by:

indexOf in interface it.unimi.dsi.fastutil.BigList<java.lang.Integer>

Specified by:

indexOf in interface IntBigList

lastIndexOf

@Deprecated
public long lastIndexOf(java.lang.Object ok)

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

Specified by:

lastIndexOf in interface it.unimi.dsi.fastutil.BigList<java.lang.Integer>

Specified by:

lastIndexOf in interface IntBigList

remove

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

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

Specified by:

remove in interface it.unimi.dsi.fastutil.BigList<java.lang.Integer>

Specified by:

remove in interface IntBigList

push

@Deprecated
public void push(java.lang.Integer o)

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

Specified by:

push in interface it.unimi.dsi.fastutil.ints.IntStack

Specified by:

push in interface it.unimi.dsi.fastutil.Stack<java.lang.Integer>

pop

@Deprecated
public java.lang.Integer pop()

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

Specified by:

pop in interface it.unimi.dsi.fastutil.ints.IntStack

Specified by:

pop in interface it.unimi.dsi.fastutil.Stack<java.lang.Integer>

top

@Deprecated
public java.lang.Integer top()

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

Specified by:

top in interface it.unimi.dsi.fastutil.ints.IntStack

Specified by:

top in interface it.unimi.dsi.fastutil.Stack<java.lang.Integer>

peek

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

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

Specified by:

peek in interface it.unimi.dsi.fastutil.ints.IntStack

Specified by:

peek in interface it.unimi.dsi.fastutil.Stack<java.lang.Integer>

toString

public java.lang.String toString()

Overrides:

toString in class it.unimi.dsi.fastutil.ints.AbstractIntCollection