it.unimi.dsi.fastutil.objects

Class AbstractReferenceBigList<K>

java.lang.Object

java.util.AbstractCollection<K>

it.unimi.dsi.fastutil.objects.AbstractReferenceCollection<K>

it.unimi.dsi.fastutil.objects.AbstractReferenceBigList<K>

All Implemented Interfaces:

it.unimi.dsi.fastutil.BigList<K>, it.unimi.dsi.fastutil.objects.ObjectIterable<K>, ReferenceBigList<K>, it.unimi.dsi.fastutil.objects.ReferenceCollection<K>, it.unimi.dsi.fastutil.Size64, it.unimi.dsi.fastutil.Stack<K>, java.lang.Iterable<K>, java.util.Collection<K>

Direct Known Subclasses:

AbstractReferenceBigList.ReferenceSubList

public abstract class AbstractReferenceBigList<K>
extends it.unimi.dsi.fastutil.objects.AbstractReferenceCollection<K>
implements ReferenceBigList<K>, it.unimi.dsi.fastutil.Stack<K>

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 K>)) 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	AbstractReferenceBigList.ReferenceRandomAccessSubList<K>
static class	AbstractReferenceBigList.ReferenceSubList<K> A class implementing a sublist view.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractReferenceBigList()

Method Summary

Modifier and Type	Method and Description
boolean	add(K k)
void	add(long index, K k)
boolean	addAll(java.util.Collection<? extends K> c)
boolean	addAll(long index, java.util.Collection<? extends K> c) Adds all of the elements in the specified collection to this list (optional operation).
void	addElements(long index, K[][] a) Add (hopefully quickly) elements to this type-specific big list.
void	addElements(long index, K[][] a, long offset, long length) Add (hopefully quickly) elements to this type-specific big list.
void	clear()
boolean	contains(java.lang.Object 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.Consumer<? super K> action)
void	getElements(long from, java.lang.Object[][] 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(java.lang.Object k)
it.unimi.dsi.fastutil.objects.ObjectBigListIterator<K>	iterator() Returns a type-specific iterator on the elements of this list.
long	lastIndexOf(java.lang.Object k)
it.unimi.dsi.fastutil.objects.ObjectBigListIterator<K>	listIterator() Returns a type-specific big-list iterator on this type-specific big list.
it.unimi.dsi.fastutil.objects.ObjectBigListIterator<K>	listIterator(long index) Returns a type-specific list iterator on this type-specific big list starting at a given index.
K	peek(int i)
K	pop()
void	push(K o)
K	remove(long i)
void	removeElements(long from, long to) Removes (hopefully quickly) elements of this type-specific big list.
K	set(long index, K k)
void	setElements(long index, K[][] 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)
ReferenceBigList<K>	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.
K	top()
java.lang.String	toString()

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, remove, removeAll, retainAll, 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.objects.ReferenceBigList

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

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

get

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

size64, sizeOf, sizeOf

Methods inherited from interface java.util.Collection

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

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

isEmpty

Constructor Detail

AbstractReferenceBigList

protected AbstractReferenceBigList()

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

Specified by:

add in interface it.unimi.dsi.fastutil.BigList<K>

add

public boolean add(K k)

Specified by:

add in interface java.util.Collection<K>

Overrides:

add in class java.util.AbstractCollection<K>

remove

public K remove(long i)

Specified by:

remove in interface it.unimi.dsi.fastutil.BigList<K>

set

public K set(long index,
             K k)

Specified by:

set in interface it.unimi.dsi.fastutil.BigList<K>

addAll

public boolean addAll(long index,
                      java.util.Collection<? extends K> 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<K>

addAll

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

Specified by:

addAll in interface java.util.Collection<K>

Overrides:

addAll in class java.util.AbstractCollection<K>

iterator

public it.unimi.dsi.fastutil.objects.ObjectBigListIterator<K> iterator()

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

Specified by:

iterator in interface it.unimi.dsi.fastutil.objects.ObjectIterable<K>

Specified by:

iterator in interface ReferenceBigList<K>

Specified by:

iterator in interface it.unimi.dsi.fastutil.objects.ReferenceCollection<K>

Specified by:

iterator in interface java.lang.Iterable<K>

Specified by:

iterator in interface java.util.Collection<K>

Overrides:

iterator in class it.unimi.dsi.fastutil.objects.AbstractReferenceCollection<K>

See Also:

Collection.iterator()

listIterator

public it.unimi.dsi.fastutil.objects.ObjectBigListIterator<K> listIterator()

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

Specified by:

listIterator in interface it.unimi.dsi.fastutil.BigList<K>

Specified by:

listIterator in interface ReferenceBigList<K>

See Also:

BigList.listIterator()

listIterator

public it.unimi.dsi.fastutil.objects.ObjectBigListIterator<K> 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<K>

Specified by:

listIterator in interface ReferenceBigList<K>

See Also:

BigList.listIterator(long)

contains

public boolean contains(java.lang.Object k)

Returns true if this list contains the specified element.

Specified by:

contains in interface java.util.Collection<K>

Overrides:

contains in class java.util.AbstractCollection<K>

See Also:

Collection.contains(Object)

indexOf

public long indexOf(java.lang.Object k)

Specified by:

indexOf in interface it.unimi.dsi.fastutil.BigList<K>

lastIndexOf

public long lastIndexOf(java.lang.Object k)

Specified by:

lastIndexOf in interface it.unimi.dsi.fastutil.BigList<K>

size

public void size(long size)

Specified by:

size in interface it.unimi.dsi.fastutil.BigList<K>

subList

public ReferenceBigList<K> subList(long from,
                                   long to)

Description copied from interface: ReferenceBigList

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

Specified by:

subList in interface ReferenceBigList<K>

See Also:

BigList.subList(long,long)

forEach

public void forEach(java.util.function.Consumer<? super K> action)

Specified by:

forEach in interface java.lang.Iterable<K>

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 ReferenceBigList<K>

Parameters:

from - the start index (inclusive).

to - the end index (exclusive).

addElements

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

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

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

Specified by:

addElements in interface ReferenceBigList<K>

Parameters:

index - the index at which to add elements.

a - the big array containing the elements.

getElements

public void getElements(long from,
                        java.lang.Object[][] 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 ReferenceBigList<K>

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

Description copied from interface: ReferenceBigList

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 ReferenceBigList<K>

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

Overrides:

clear in class java.util.AbstractCollection<K>

size

@Deprecated
public int size()

Deprecated. Please use Size64.size64() instead.

Specified by:

size in interface it.unimi.dsi.fastutil.BigList<K>

Specified by:

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

Specified by:

size in interface java.util.Collection<K>

Specified by:

size in class java.util.AbstractCollection<K>

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

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

Overrides:

equals in class java.lang.Object

push

public void push(K o)

Specified by:

push in interface it.unimi.dsi.fastutil.Stack<K>

pop

public K pop()

Specified by:

pop in interface it.unimi.dsi.fastutil.Stack<K>

top

public K top()

Specified by:

top in interface it.unimi.dsi.fastutil.Stack<K>

peek

public K peek(int i)

Specified by:

peek in interface it.unimi.dsi.fastutil.Stack<K>

toString

public java.lang.String toString()

Overrides:

toString in class it.unimi.dsi.fastutil.objects.AbstractReferenceCollection<K>