it.unimi.dsi.fastutil.ints

Class AbstractIntBigList

java.lang.Object

java.util.AbstractCollection<Integer>

it.unimi.dsi.fastutil.ints.AbstractIntCollection

it.unimi.dsi.fastutil.ints.AbstractIntBigList

All Implemented Interfaces:

BigList<Integer>, IntBigList, IntCollection, IntIterable, IntStack, Size64, Stack<Integer>, Comparable<BigList<? extends Integer>>, Iterable<Integer>, Collection<Integer>

Direct Known Subclasses:

AbstractIntBigList.IntSubList, IntBigArrayBigList, IntBigLists.ListBigList, IntBigLists.Singleton

public abstract class AbstractIntBigList
extends AbstractIntCollection
implements IntBigList, IntStack

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	AbstractIntBigList.IntSubList A class implementing a sublist view.

Method Summary

Modifier and Type	Method and Description
boolean	add(int k) Ensures that this collection contains the specified element (optional operation).
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, Integer ok) Deprecated. Please use the corresponding type-specific method instead.
boolean	addAll(Collection<? extends Integer> c) Adds all of the elements in the specified collection to this collection (optional operation).
boolean	addAll(IntBigList l) Appends all of the elements in the specified type-specific big list to the end of this type-specific big list (optional operation).
boolean	addAll(IntCollection c) Adds all elements of the given type-specific collection to this collection.
boolean	addAll(long index, Collection<? extends Integer> c) Adds all of the elements in the specified collection to this list (optional operation).
boolean	addAll(long index, IntBigList l) Inserts all of the elements in the specified type-specific big list into this type-specific big list at the specified position (optional operation).
boolean	addAll(long index, 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() Removes all of the elements from this collection (optional operation).
int	compareTo(BigList<? extends Integer> l) Compares this big list to another object.
boolean	contains(int k) Returns true if this list contains the specified element.
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
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(Object ok) Deprecated. Please use the corresponding type-specific method instead.
IntBigListIterator	iterator() Returns an iterator over the elements contained in this collection.
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(Object ok) Deprecated. Please use the corresponding type-specific method instead.
IntBigListIterator	listIterator() Returns a type-specific big-list iterator on this type-specific big list.
IntBigListIterator	listIterator(long index) Returns a type-specific list iterator on this type-specific big list starting at a given index.
Integer	peek(int i) Deprecated. Please use the corresponding type-specific method instead.
int	peekInt(int i) Peeks at an element on the stack (optional operation).
Integer	pop() Deprecated. Please use the corresponding type-specific method instead.
int	popInt() Pops the top off the stack.
void	push(int o) Pushes the given object on the stack.
void	push(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).
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).
Integer	set(long index, Integer ok) Deprecated. Please use the corresponding type-specific method instead.
int	size() Deprecated. Please use Size64.size64() instead.
void	size(long size) Sets the size of this big list.
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.
Integer	top() Deprecated. Please use the corresponding type-specific method instead.
int	topInt() Peeks at the top of the stack (optional operation).
String	toString() Returns a string representation of this collection.

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

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

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

getInt

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

size64

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

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

Methods inherited from interface java.util.Collection

containsAll, isEmpty, parallelStream, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray

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

forEach, forEach

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

isEmpty

Method Detail

add

public void add(long index,
                int k)

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

This implementation always throws an UnsupportedOperationException.

Specified by:

add in interface IntBigList

See Also:

BigList.add(long,Object)

add

public boolean add(int k)

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

This implementation always throws an UnsupportedOperationException.

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

Specified by:

add in interface IntCollection

Overrides:

add in class AbstractIntCollection

See Also:

Collection.add(Object)

removeInt

public int removeInt(long i)

Removes the element at the specified position.

This implementation always throws an UnsupportedOperationException.

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

This implementation always throws an UnsupportedOperationException.

Specified by:

set in interface IntBigList

See Also:

BigList.set(long,Object)

addAll

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

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

Specified by:

addAll in interface BigList<Integer>

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 Integer> c)

Adds all of the elements in the specified collection to this collection (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified collection is this collection, and this collection is nonempty.)

This implementation iterates over the specified collection, and adds each object returned by the iterator to this collection, in turn.

Note that this implementation will throw an UnsupportedOperationException unless add is overridden (assuming the specified collection is non-empty).

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

Specified by:

addAll in interface Collection<Integer>

Overrides:

addAll in class AbstractCollection<Integer>

Parameters:

c - collection containing elements to be added to this collection

Returns:

true if this collection changed as a result of the call

See Also:

AbstractCollection.add(Object)

iterator

public IntBigListIterator iterator()

Returns an iterator over the elements contained in this collection.

This implementation delegates to listIterator().

Specified by:

iterator in interface IntBigList

Specified by:

iterator in interface IntCollection

Specified by:

iterator in interface IntIterable

Specified by:

iterator in interface Iterable<Integer>

Specified by:

iterator in interface Collection<Integer>

Specified by:

iterator in class AbstractIntCollection

Returns:

an iterator over the elements contained in this collection

See Also:

Iterable.iterator()

listIterator

public IntBigListIterator listIterator()

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

Note that this specification strengthens the one given in BigList.listIterator().

This implementation delegates to listIterator(0).

Specified by:

listIterator in interface BigList<Integer>

Specified by:

listIterator in interface IntBigList

Returns:

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

See Also:

BigList.listIterator()

listIterator

public IntBigListIterator listIterator(long index)

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

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

This implementation is based on the random-access methods.

Specified by:

listIterator in interface BigList<Integer>

Specified by:

listIterator in interface IntBigList

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)

contains

public boolean contains(int k)

Returns true if this list contains the specified element.

This implementation delegates to indexOf().

Specified by:

contains in interface IntCollection

Overrides:

contains in class 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)

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

Parameters:

size - the new size.

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.

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

Specified by:

subList in interface BigList<Integer>

Specified by:

subList in interface IntBigList

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

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

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.

clear

public void clear()

Removes all of the elements from this collection (optional operation). The collection will be empty after this method returns.

This implementation iterates over this collection, removing each element using the Iterator.remove operation. Most implementations will probably choose to override this method for efficiency.

Note that this implementation will throw an UnsupportedOperationException if the iterator returned by this collection's iterator method does not implement the remove method and this collection is non-empty.

This implementation delegates to removeElements(long, long).

Specified by:

clear in interface Collection<Integer>

Overrides:

clear in class AbstractCollection<Integer>

size

@Deprecated
public int size()

Deprecated. Please use Size64.size64() instead.

Returns the number of elements in this collection. If this collection contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

This implementation delegates to Size64.size64().

Specified by:

size in interface Size64

Specified by:

size in interface Collection<Integer>

Specified by:

size in class AbstractCollection<Integer>

Returns:

the number of elements in this collection

See Also:

Collection.size()

hashCode

public int hashCode()

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

Specified by:

hashCode in interface Collection<Integer>

Overrides:

hashCode in class Object

Returns:

the hash code for this big list.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

equals

public boolean equals(Object o)

Description copied from class: java.lang.Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Specified by:

equals in interface Collection<Integer>

Overrides:

equals in class Object

Parameters:

o - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Object.hashCode(), HashMap

compareTo

public int compareTo(BigList<? extends 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 Comparable<BigList<? extends 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:

ClassCastException - if the argument is not a big list.

push

public void push(int o)

Description copied from interface: IntStack

Pushes the given object on the stack.

Specified by:

push in interface IntStack

Parameters:

o - the object to push on the stack.

See Also:

Stack.push(Object)

popInt

public int popInt()

Description copied from interface: IntStack

Pops the top off the stack.

Specified by:

popInt in interface IntStack

Returns:

the top of the stack.

See Also:

Stack.pop()

topInt

public int topInt()

Description copied from interface: IntStack

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

Specified by:

topInt in interface IntStack

Returns:

the top of the stack.

See Also:

Stack.top()

peekInt

public int peekInt(int i)

Description copied from interface: IntStack

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

Specified by:

peekInt in interface IntStack

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(int k)

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

This implementation delegates to indexOf().

Specified by:

rem in interface IntCollection

Overrides:

rem in class AbstractIntCollection

See Also:

Collection.remove(Object)

addAll

public boolean addAll(long index,
                      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).

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

Specified by:

addAll in interface IntBigList

See Also:

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

addAll

public boolean addAll(long index,
                      IntBigList l)

Inserts all of the elements in the specified type-specific big list into this type-specific big list at the specified position (optional operation).

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

Specified by:

addAll in interface IntBigList

See Also:

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

addAll

public boolean addAll(IntCollection c)

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

This implementation delegates to the type-specific version of addAll(long, 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(IntBigList l)

Appends all of the elements in the specified type-specific big list to the end of this type-specific big list (optional operation).

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

Specified by:

addAll in interface IntBigList

See Also:

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

add

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

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

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

This implementation delegates to the corresponding type-specific method.

Specified by:

add in interface BigList<Integer>

Specified by:

add in interface IntBigList

Parameters:

index - a position in the big list.

ok - an element to be inserted.

See Also:

List.add(int,Object)

set

@Deprecated
public Integer set(long index,
                               Integer 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).

This implementation delegates to the corresponding type-specific method.

Specified by:

set in interface BigList<Integer>

Specified by:

set in interface IntBigList

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

@Deprecated
public Integer get(long index)

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

Returns the element at the specified position.

This implementation delegates to the corresponding type-specific method.

Specified by:

get in interface BigList<Integer>

Specified by:

get in interface IntBigList

Parameters:

index - a position in the big list.

Returns:

the element at the specified position.

See Also:

List.get(int)

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.

This implementation delegates to the corresponding type-specific method.

Specified by:

indexOf in interface BigList<Integer>

Specified by:

indexOf in interface IntBigList

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

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

This implementation delegates to the corresponding type-specific method.

Specified by:

lastIndexOf in interface BigList<Integer>

Specified by:

lastIndexOf in interface IntBigList

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

@Deprecated
public Integer remove(long index)

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

Removes the element at the specified position.

This implementation delegates to the corresponding type-specific method.

Specified by:

remove in interface BigList<Integer>

Specified by:

remove in interface IntBigList

Parameters:

index - a position in the big list.

Returns:

the element previously at the specified position.

See Also:

List.remove(int)

push

@Deprecated
public void push(Integer 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.

This implementation delegates to the corresponding type-specific method.

Specified by:

push in interface IntStack

Specified by:

push in interface Stack<Integer>

Parameters:

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

pop

@Deprecated
public Integer 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.

This implementation delegates to the corresponding type-specific method.

Specified by:

pop in interface IntStack

Specified by:

pop in interface Stack<Integer>

Returns:

the top of the stack.

top

@Deprecated
public Integer 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.

This implementation delegates to the corresponding type-specific method.

Specified by:

top in interface IntStack

Specified by:

top in interface Stack<Integer>

Returns:

the top of the stack.

peek

@Deprecated
public Integer 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.

This implementation delegates to the corresponding type-specific method.

Specified by:

peek in interface IntStack

Specified by:

peek in interface Stack<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 String toString()

Description copied from class: java.util.AbstractCollection

Returns a string representation of this collection. The string representation consists of a list of the collection's elements in the order they are returned by its iterator, enclosed in square brackets ("[]"). Adjacent elements are separated by the characters ", " (comma and space). Elements are converted to strings as by String.valueOf(Object).

Overrides:

toString in class AbstractIntCollection

Returns:

a string representation of this collection