Class AbstractIntList
- All Implemented Interfaces:
IntCollection,IntIterable,IntList,it.unimi.dsi.fastutil.ints.IntStack,it.unimi.dsi.fastutil.Stack<Integer>,Comparable<List<? extends Integer>>,Iterable<Integer>,Collection<Integer>,List<Integer>,SequencedCollection<Integer>
- Direct Known Subclasses:
AbstractIntList.IntSubList,IntArrayList,IntImmutableList,IntLists.Singleton
As an additional bonus, this class implements on top of the list operations a type-specific stack.
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(int) and the xAll() methods
(such as addAll(int, java.util.Collection<? extends java.lang.Integer>)) with a more appropriate iteration scheme. Note the subList(int, int)
method is cognizant of random-access or not, so that need not be reimplemented.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic classA class implementing a sublist view. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanadd(int k) Ensures that this collection contains the specified element (optional operation).voidadd(int index, int k) Inserts the specified element at the specified position in this list (optional operation).booleanaddAll(int index, IntCollection c) Inserts all of the elements in the specified type-specific collection into this type-specific list at the specified position (optional operation).booleanaddAll(int index, Collection<? extends Integer> c) Adds all of the elements in the specified collection to this list (optional operation).booleanAdds all elements of the given type-specific collection to this collection.booleanaddAll(Collection<? extends Integer> c) voidaddElements(int index, int[] a) Add (hopefully quickly) elements to this type-specific list.voidaddElements(int index, int[] a, int offset, int length) Add (hopefully quickly) elements to this type-specific list.voidclear()intCompares this list to another object.booleancontains(int k) Returns true if this list contains the specified element.protected voidensureIndex(int index) Ensures that the given index is nonnegative and not greater than the list size.protected voidensureRestrictedIndex(int index) Ensures that the given index is nonnegative and smaller than the list size.booleanvoidforEach(IntConsumer action) Performs the given action for each element of this type-specificIterableuntil all elements have been processed or the action throws an exception.voidgetElements(int from, int[] a, int offset, int length) Copies (hopefully quickly) elements of this type-specific list into the given array.inthashCode()Returns the hash code for this list, which is identical toList.hashCode().intindexOf(int k) Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.iterator()Returns a type-specific iterator on the elements of this collection.intlastIndexOf(int k) Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.Returns a type-specific list iterator on the list.listIterator(int index) Returns a type-specific list iterator on the list starting at a given index.intpeekInt(int i) intpopInt()voidpush(int o) booleanrem(int k) Removes a single instance of the specified element from this collection, if it is present (optional operation).voidremoveElements(int from, int to) Removes (hopefully quickly) elements of this type-specific list.intremoveInt(int i) Removes the element at the specified position in this list (optional operation).final voidreplaceAll(IntUnaryOperator operator) Replaces each element of this list with the result of applying the operator to that element.intset(int index, int k) Replaces the element at the specified position in this list with the specified element (optional operation).voidsetElements(int index, int[] a, int offset, int length) Set (hopefully quickly) elements to match the array given.voidsize(int size) Sets the size of this list.subList(int from, int to) Returns a type-specific view of the portion of this list from the indexfrom, inclusive, to the indexto, exclusive.int[]toArray(int[] a) Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.int[]Returns a primitive type array containing the items of this collection.inttopInt()toString()Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractIntCollection
add, contains, containsAll, containsAll, forEach, remove, removeAll, removeAll, removeIf, retainAll, retainAll, toIntArrayMethods inherited from class java.util.AbstractCollection
isEmpty, size, toArray, toArrayMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.Collection
toArrayMethods inherited from interface it.unimi.dsi.fastutil.ints.IntCollection
containsAll, intIterator, intParallelStream, intSpliterator, intStream, parallelStream, removeAll, removeIf, removeIf, removeIf, retainAll, spliterator, stream, toIntArrayMethods inherited from interface it.unimi.dsi.fastutil.ints.IntIterable
forEach, forEachMethods inherited from interface it.unimi.dsi.fastutil.ints.IntList
add, add, addAll, addAll, contains, get, getInt, indexOf, lastIndexOf, remove, remove, replaceAll, replaceAll, set, setElements, setElements, sort, sort, spliterator, unstableSort, unstableSortMethods inherited from interface it.unimi.dsi.fastutil.ints.IntStack
peek, pop, push, topMethods inherited from interface java.util.List
addFirst, addLast, containsAll, getFirst, getLast, isEmpty, removeAll, removeFirst, removeLast, retainAll, reversed, size, toArray, toArrayMethods inherited from interface it.unimi.dsi.fastutil.Stack
isEmpty
-
Constructor Details
-
AbstractIntList
protected AbstractIntList()
-
-
Method Details
-
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:
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:
IndexOutOfBoundsException- if the given index is negative or not smaller than the list size.
-
add
public void add(int index, int k) Inserts the specified element at the specified position in this list (optional operation). -
add
public boolean add(int k) Ensures that this collection contains the specified element (optional operation).- Specified by:
addin interfaceIntCollection- Specified by:
addin interfaceIntList- Overrides:
addin classAbstractIntCollection- See Also:
-
removeInt
public int removeInt(int i) Removes the element at the specified position in this list (optional operation). -
set
public int set(int index, int k) Replaces the element at the specified position in this list with the specified element (optional operation). -
addAll
Adds all of the elements in the specified collection to this list (optional operation). -
addAll
- Specified by:
addAllin interfaceCollection<Integer>- Specified by:
addAllin interfaceList<Integer>- Overrides:
addAllin classAbstractIntCollection
-
iterator
Returns a type-specific iterator on the elements of this collection.- Specified by:
iteratorin interfaceCollection<Integer>- Specified by:
iteratorin interfaceIntCollection- Specified by:
iteratorin interfaceIntIterable- Specified by:
iteratorin interfaceIntList- Specified by:
iteratorin interfaceIterable<Integer>- Specified by:
iteratorin interfaceList<Integer>- Specified by:
iteratorin classAbstractIntCollection- Returns:
- a type-specific iterator on the elements of this collection.
- See Also:
-
listIterator
Returns a type-specific list iterator on the list.- Specified by:
listIteratorin interfaceIntList- Specified by:
listIteratorin interfaceList<Integer>- See Also:
-
listIterator
Returns a type-specific list iterator on the list starting at a given index.- Specified by:
listIteratorin interfaceIntList- Specified by:
listIteratorin interfaceList<Integer>- See Also:
-
contains
public boolean contains(int k) Returns true if this list contains the specified element.- Specified by:
containsin interfaceIntCollection- Overrides:
containsin classAbstractIntCollection- See Also:
-
indexOf
public int indexOf(int k) Description copied from interface:IntListReturns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element. -
lastIndexOf
public int lastIndexOf(int k) Description copied from interface:IntListReturns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.- Specified by:
lastIndexOfin interfaceIntList- See Also:
-
size
public void size(int size) Description copied from interface:IntListSets 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. -
subList
Description copied from interface:IntListReturns a type-specific view of the portion of this list from the indexfrom, inclusive, to the indexto, exclusive. -
forEach
Performs the given action for each element of this type-specificIterableuntil all elements have been processed or the action throws an exception.- Specified by:
forEachin interfaceIntIterable- Parameters:
action- the action to be performed for each element.- See Also:
-
removeElements
public void removeElements(int from, int to) Removes (hopefully quickly) elements of this type-specific list.This is a trivial iterator-based based implementation. It is expected that implementations will override this method with a more optimized version.
- Specified by:
removeElementsin interfaceIntList- Parameters:
from- the start index (inclusive).to- the end index (exclusive).
-
addElements
public void addElements(int index, int[] a, int offset, int length) Add (hopefully quickly) elements to this type-specific list.This is a trivial iterator-based implementation. It is expected that implementations will override this method with a more optimized version.
- Specified by:
addElementsin interfaceIntList- 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) Add (hopefully quickly) elements to this type-specific list.- Specified by:
addElementsin interfaceIntList- 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 (hopefully quickly) elements of this type-specific list into the given array.This is a trivial iterator-based implementation. It is expected that implementations will override this method with a more optimized version.
- Specified by:
getElementsin interfaceIntList- 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.
-
setElements
public void setElements(int index, int[] a, int offset, int length) Description copied from interface:IntListSet (hopefully quickly) elements to match the array given. Sets each in this list to the corresponding elements in the array, as if byListIterator iter = listIterator(index); int i = 0; while (i < length) { iter.next(); iter.set(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:
setElementsin interfaceIntList- Parameters:
index- the index at which to start setting elements.a- the array containing the elementsoffset- the offset of the first element to add.length- the number of elements to add.
-
clear
public void clear()- Specified by:
clearin interfaceCollection<Integer>- Specified by:
clearin interfaceList<Integer>- Overrides:
clearin classAbstractCollection<Integer>
-
hashCode
public int hashCode()Returns the hash code for this list, which is identical toList.hashCode(). -
equals
-
compareTo
Compares this list to another object. If the argument is aList, this method performs a lexicographical comparison; otherwise, it throws aClassCastException.- Specified by:
compareToin interfaceComparable<List<? extends 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:
ClassCastException- if the argument is not a list.
-
push
public void push(int o) - Specified by:
pushin interfaceit.unimi.dsi.fastutil.ints.IntStack
-
popInt
public int popInt()- Specified by:
popIntin interfaceit.unimi.dsi.fastutil.ints.IntStack
-
topInt
public int topInt()- Specified by:
topIntin interfaceit.unimi.dsi.fastutil.ints.IntStack
-
peekInt
public int peekInt(int i) - Specified by:
peekIntin interfaceit.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:
remin interfaceIntCollection- Overrides:
remin classAbstractIntCollection- See Also:
-
toIntArray
public int[] toIntArray()Description copied from interface:IntCollectionReturns a primitive type array containing the items of this collection.- Specified by:
toIntArrayin interfaceIntCollection- Overrides:
toIntArrayin classAbstractIntCollection- Returns:
- a primitive type array containing the items of this collection.
- See Also:
-
toArray
public int[] toArray(int[] a) Description copied from interface:IntCollectionReturns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.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:
toArrayin interfaceIntCollection- Overrides:
toArrayin classAbstractIntCollection- 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:
-
addAll
Description copied from interface:IntListInserts all of the elements in the specified type-specific collection into this type-specific list at the specified position (optional operation). -
addAll
Adds all elements of the given type-specific collection to this collection.- Specified by:
addAllin interfaceIntCollection- Overrides:
addAllin classAbstractIntCollection- Parameters:
c- a type-specific collection.- Returns:
trueif this collection changed as a result of the call.- See Also:
-
replaceAll
Replaces each element of this list with the result of applying the operator to that element.WARNING: Overriding this method is almost always a mistake, as this overload only exists to disambiguate. Instead, override the
replaceAll()overload that uses the JDK's primitive unary operator type (e.g.IntUnaryOperator).If Java supported final default methods, this would be one, but sadly it does not.
If you checked and are overriding the version with
java.util.function.XUnaryOperator, and still see this warning, then your IDE is incorrectly conflating this method with the proper method to override, and you can safely ignore this message.- Specified by:
replaceAllin interfaceIntList- Parameters:
operator- the operator to apply to each element- See Also:
-
toString
- Overrides:
toStringin classAbstractIntCollection
-