Class IntImmutableList
- All Implemented Interfaces:
IntCollection
,IntIterable
,IntList
,IntStack
,Stack<Integer>
,Serializable
,Cloneable
,Comparable<List<? extends Integer>>
,Iterable<Integer>
,Collection<Integer>
,List<Integer>
,RandomAccess
,SequencedCollection<Integer>
Instances of this class are immutable and (contrarily to mutable array-based list implementations) the backing array is not exposed. Instances can be built using a variety of methods, but note that constructors using an array will not make a defensive copy.
This class implements the bulk method getElements()
using high-performance system calls
(e.g., System.arraycopy()
) instead of
expensive loops.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.ints.AbstractIntList
AbstractIntList.IntRandomAccessSubList, AbstractIntList.IntSubList
-
Constructor Summary
ConstructorDescriptionIntImmutableList
(int[] a) Creates a new immutable list using a given array.IntImmutableList
(int[] a, int offset, int length) Creates a new immutable list and fills it with the elements of a given array.Creates a new immutable list and fills it with a given type-specific collection.Creates a new immutable list and fills it with the elements returned by a type-specific iterator..Creates a new immutable list and fills it with a given type-specific list.IntImmutableList
(Collection<? extends Integer> c) Creates a new immutable list and fills it with a given collection. -
Method Summary
Modifier and TypeMethodDescriptionfinal boolean
add
(int k) Deprecated.final void
add
(int index, int k) Deprecated.final void
Deprecated.final boolean
Deprecated.final boolean
addAll
(int index, IntCollection c) Deprecated.final boolean
Deprecated.final boolean
addAll
(int index, Collection<? extends Integer> c) Deprecated.final boolean
Deprecated.final boolean
Deprecated.final boolean
addAll
(Collection<? extends Integer> c) Deprecated.final void
addElements
(int index, int[] a, int offset, int length) Deprecated.final void
clear()
Deprecated.clone()
int
Compares this immutable list to another immutable list.int
Compares this list to another object.boolean
Compares this type-specific immutable list to another one.boolean
void
forEach
(IntConsumer action) Performs the given action for each element of this type-specificIterable
until all elements have been processed or the action throws an exception.void
getElements
(int from, int[] a, int offset, int length) Copies element of this type-specific list into the given array using optimized system calls.int
getInt
(int index) Returns the element at the specified position in this list.int
indexOf
(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.boolean
isEmpty()
Checks whether the stack is empty.int
lastIndexOf
(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.listIterator
(int index) Returns a type-specific list iterator on the list starting at a given index.static IntImmutableList
of()
Returns an empty immutable list.static IntImmutableList
of
(int... init) Creates an immutable list using a list of elements.final boolean
rem
(int k) Deprecated.final Integer
remove
(int index) Deprecated.final boolean
Deprecated.final boolean
Deprecated.final boolean
removeAll
(Collection<?> c) Deprecated.final void
removeElements
(int from, int to) Deprecated.final boolean
Deprecated.final boolean
Deprecated.final int
removeInt
(int index) Deprecated.final void
replaceAll
(IntUnaryOperator operator) Deprecated.final void
replaceAll
(UnaryOperator<Integer> operator) Deprecated.final boolean
Deprecated.final boolean
retainAll
(Collection<?> c) Deprecated.final int
set
(int index, int k) Deprecated.final Integer
Deprecated.final void
setElements
(int index, int[] a, int offset, int length) Deprecated.int
size()
final void
size
(int size) Deprecated.final void
sort
(IntComparator comp) Deprecated.final void
sort
(Comparator<? super Integer> comparator) Deprecated.Returns a type-specific spliterator on the elements 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.static IntImmutableList
Collects the result of a primitiveStream
into a new ImmutableList.static IntImmutableList
toListWithExpectedSize
(IntStream stream, int expectedSize) Collects the result of a primitiveStream
into a new ImmutableList, potentially pre-allocated to handle the given size.final void
unstableSort
(IntComparator comp) Deprecated.final void
unstableSort
(Comparator<? super Integer> comparator) Deprecated.Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractIntList
addElements, contains, hashCode, iterator, listIterator, peekInt, popInt, push, replaceAll, topInt, toString
Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractIntCollection
contains, containsAll, containsAll, forEach, removeIf, toIntArray
Methods inherited from class java.util.AbstractCollection
toArray, toArray
Methods inherited from interface java.util.Collection
toArray
Methods inherited from interface it.unimi.dsi.fastutil.ints.IntCollection
addAll, contains, containsAll, intIterator, intParallelStream, intSpliterator, intStream, parallelStream, rem, removeAll, removeIf, removeIf, removeIf, retainAll, stream, toIntArray
Methods inherited from interface it.unimi.dsi.fastutil.ints.IntIterable
forEach, forEach
Methods inherited from interface it.unimi.dsi.fastutil.ints.IntList
add, add, add, add, addAll, addAll, addAll, addElements, addElements, contains, get, indexOf, iterator, lastIndexOf, listIterator, remove, remove, removeElements, removeInt, replaceAll, replaceAll, replaceAll, set, set, setElements, setElements, setElements, size, sort, sort, unstableSort, unstableSort
-
Constructor Details
-
IntImmutableList
public IntImmutableList(int[] a) Creates a new immutable list using a given array.Note that this constructor does not perform a defensive copy.
- Parameters:
a
- the array that will be used to back this immutable list.
-
IntImmutableList
Creates a new immutable list and fills it with a given collection.- Parameters:
c
- a collection that will be used to fill the immutable list.
-
IntImmutableList
Creates a new immutable list and fills it with a given type-specific collection.- Parameters:
c
- a type-specific collection that will be used to fill the immutable list.
-
IntImmutableList
Creates a new immutable list and fills it with a given type-specific list.- Parameters:
l
- a type-specific list that will be used to fill the immutable list.
-
IntImmutableList
public IntImmutableList(int[] a, int offset, int length) Creates a new immutable list and fills it with the elements of a given array.- Parameters:
a
- an array whose elements will be used to fill the immutable list.offset
- the first element to use.length
- the number of elements to use.
-
IntImmutableList
Creates a new immutable list and fills it with the elements returned by a type-specific iterator..- Parameters:
i
- a type-specific iterator whose returned elements will fill the immutable list.
-
-
Method Details
-
of
Returns an empty immutable list.- Returns:
- an immutable list (possibly shared) that is empty.
-
of
Creates an immutable list using a list of elements.Note that this method does not perform a defensive copy.
- Parameters:
init
- a list of elements that will be used to initialize the list.- Returns:
- a new immutable list containing the given elements.
-
toList
Collects the result of a primitiveStream
into a new ImmutableList.This method performs a terminal operation on the given
Stream
- API Notes:
- Taking a primitive stream instead of returning something like a
Collector
is necessary because there is no primitiveCollector
equivalent in the Java API.
-
toListWithExpectedSize
Collects the result of a primitiveStream
into a new ImmutableList, potentially pre-allocated to handle the given size.This method performs a terminal operation on the given
Stream
- API Notes:
- Taking a primitive stream instead returning something like a
Collector
is necessary because there is no primitiveCollector
equivalent in the Java API.
-
getInt
public int getInt(int index) Description copied from interface:IntList
Returns the element at the specified position in this list. -
indexOf
public int indexOf(int k) Description copied from interface:IntList
Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.- Specified by:
indexOf
in interfaceIntList
- Overrides:
indexOf
in classAbstractIntList
- See Also:
-
lastIndexOf
public int lastIndexOf(int k) Description copied from interface:IntList
Returns 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:
lastIndexOf
in interfaceIntList
- Overrides:
lastIndexOf
in classAbstractIntList
- See Also:
-
size
public int size()- Specified by:
size
in interfaceCollection<Integer>
- Specified by:
size
in interfaceList<Integer>
- Specified by:
size
in classAbstractCollection<Integer>
-
isEmpty
public boolean isEmpty()Description copied from interface:Stack
Checks whether the stack is empty. -
getElements
public void getElements(int from, int[] a, int offset, int length) Copies element of this type-specific list into the given array using optimized system calls.- Specified by:
getElements
in interfaceIntList
- Overrides:
getElements
in classAbstractIntList
- 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.
-
forEach
Description copied from class:AbstractIntList
Performs the given action for each element of this type-specificIterable
until all elements have been processed or the action throws an exception.- Specified by:
forEach
in interfaceIntIterable
- Overrides:
forEach
in classAbstractIntList
- Parameters:
action
- the action to be performed for each element.- See Also:
-
toIntArray
public int[] toIntArray()Description copied from interface:IntCollection
Returns a primitive type array containing the items of this collection.- Specified by:
toIntArray
in interfaceIntCollection
- Overrides:
toIntArray
in classAbstractIntList
- Returns:
- a primitive type array containing the items of this collection.
- See Also:
-
toArray
public int[] toArray(int[] a) Description copied from interface:IntCollection
Returns 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:
toArray
in interfaceIntCollection
- Overrides:
toArray
in classAbstractIntList
- 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:
-
listIterator
Description copied from class:AbstractIntList
Returns a type-specific list iterator on the list starting at a given index.- Specified by:
listIterator
in interfaceIntList
- Specified by:
listIterator
in interfaceList<Integer>
- Overrides:
listIterator
in classAbstractIntList
- See Also:
-
spliterator
Description copied from interface:IntList
Returns a type-specific spliterator on the elements of this list.List spliterators must report at least
Spliterator.SIZED
andSpliterator.ORDERED
.See
List.spliterator()
for more documentation on the requirements of the returned spliterator.- Specified by:
spliterator
in interfaceCollection<Integer>
- Specified by:
spliterator
in interfaceIntCollection
- Specified by:
spliterator
in interfaceIntIterable
- Specified by:
spliterator
in interfaceIntList
- Specified by:
spliterator
in interfaceIterable<Integer>
- Specified by:
spliterator
in interfaceList<Integer>
- Returns:
- a type-specific spliterator on the elements of this collection.
-
subList
Returns a type-specific view of the portion of this list from the indexfrom
, inclusive, to the indexto
, exclusive.- Specified by:
subList
in interfaceIntList
- Specified by:
subList
in interfaceList<Integer>
- Overrides:
subList
in classAbstractIntList
- See Also:
- API Notes:
- The returned list will be immutable, but is currently not declared to return an instance
of
ImmutableList
due to complications of implementation details. This may change in a future version (in other words, do not consider the return type of this method to be stable if making a subclass ofImmutableList
).
-
clone
-
equals
Compares this type-specific immutable list to another one.- Parameters:
l
- a type-specific immutable list.- Returns:
- true if the argument contains the same elements of this type-specific immutable list.
- API Notes:
- This method exists only for sake of efficiency. The implementation inherited from the abstract implementation would already work.
-
equals
- Specified by:
equals
in interfaceCollection<Integer>
- Specified by:
equals
in interfaceList<Integer>
- Overrides:
equals
in classAbstractIntList
-
compareTo
Compares this immutable list to another immutable list.- Parameters:
l
- an immutable list.- Returns:
- a negative integer, zero, or a positive integer as this list is lexicographically less than, equal to, or greater than the argument.
- API Notes:
- This method exists only for sake of efficiency. The implementation inherited from the abstract implementation would already work.
-
compareTo
Description copied from class:AbstractIntList
Compares this list to another object. If the argument is aList
, this method performs a lexicographical comparison; otherwise, it throws aClassCastException
.- Specified by:
compareTo
in interfaceComparable<List<? extends Integer>>
- Overrides:
compareTo
in classAbstractIntList
- 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.
-
add
Deprecated.Description copied from class:AbstractIntList
Inserts the specified element at the specified position in this list (optional operation).- Specified by:
add
in interfaceIntList
- Overrides:
add
in classAbstractIntList
- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
add
Deprecated.Description copied from class:AbstractIntList
Ensures that this collection contains the specified element (optional operation).- Specified by:
add
in interfaceIntCollection
- Specified by:
add
in interfaceIntList
- Overrides:
add
in classAbstractIntList
- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
addAll
Deprecated.Description copied from class:AbstractIntList
- Specified by:
addAll
in interfaceCollection<Integer>
- Specified by:
addAll
in interfaceList<Integer>
- Overrides:
addAll
in classAbstractIntList
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
addAll
Deprecated.Description copied from class:AbstractIntList
Adds all of the elements in the specified collection to this list (optional operation).- Specified by:
addAll
in interfaceList<Integer>
- Overrides:
addAll
in classAbstractIntList
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
removeInt
Deprecated.Description copied from class:AbstractIntList
Removes the element at the specified position in this list (optional operation).- Specified by:
removeInt
in interfaceIntList
- Overrides:
removeInt
in classAbstractIntList
- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
rem
Deprecated.Description copied from class:AbstractIntList
Removes a single instance of the specified element from this collection, if it is present (optional operation).- Specified by:
rem
in interfaceIntCollection
- Overrides:
rem
in classAbstractIntList
- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
removeAll
Deprecated.Description copied from class:AbstractIntCollection
- Specified by:
removeAll
in interfaceCollection<Integer>
- Specified by:
removeAll
in interfaceList<Integer>
- Overrides:
removeAll
in classAbstractIntCollection
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
retainAll
Deprecated.Description copied from class:AbstractIntCollection
- Specified by:
retainAll
in interfaceCollection<Integer>
- Specified by:
retainAll
in interfaceList<Integer>
- Overrides:
retainAll
in classAbstractIntCollection
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
removeIf
Deprecated.Description copied from interface:IntCollection
- Specified by:
removeIf
in interfaceCollection<Integer>
- Specified by:
removeIf
in interfaceIntCollection
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
removeIf
Deprecated.Description copied from interface:IntCollection
Remove from this collection all elements which satisfy the given predicate.- Specified by:
removeIf
in interfaceIntCollection
- Parameters:
c
- a predicate which returnstrue
for elements to be removed.- Returns:
true
if any elements were removed.- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
replaceAll
Deprecated.Description copied from interface:IntList
- Specified by:
replaceAll
in interfaceIntList
- Specified by:
replaceAll
in interfaceList<Integer>
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
replaceAll
Deprecated.Description copied from interface:IntList
Replaces each element of this list with the result of applying the operator to that element.- Specified by:
replaceAll
in interfaceIntList
- Parameters:
operator
- the operator to apply to each element.- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
add
Deprecated.Description copied from interface:IntList
-
add
Deprecated.Description copied from class:AbstractIntCollection
- Specified by:
add
in interfaceCollection<Integer>
- Specified by:
add
in interfaceIntCollection
- Specified by:
add
in interfaceIntList
- Specified by:
add
in interfaceList<Integer>
- Overrides:
add
in classAbstractIntCollection
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
remove
Deprecated.Description copied from interface:IntList
-
remove
Deprecated.Description copied from class:AbstractIntCollection
- Specified by:
remove
in interfaceCollection<Integer>
- Specified by:
remove
in interfaceIntCollection
- Specified by:
remove
in interfaceIntList
- Specified by:
remove
in interfaceList<Integer>
- Overrides:
remove
in classAbstractIntCollection
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
set
Deprecated.Description copied from interface:IntList
-
addAll
Deprecated.Description copied from class:AbstractIntList
Adds all elements of the given type-specific collection to this collection.- Specified by:
addAll
in interfaceIntCollection
- Overrides:
addAll
in classAbstractIntList
- Parameters:
c
- a type-specific collection.- Returns:
true
if this collection changed as a result of the call.- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
addAll
Deprecated.Description copied from interface:IntList
Appends all of the elements in the specified type-specific list to the end of this type-specific list (optional operation).- Specified by:
addAll
in interfaceIntList
- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
addAll
Deprecated.Description copied from interface:IntList
Inserts all of the elements in the specified type-specific collection into this type-specific list at the specified position (optional operation).- Specified by:
addAll
in interfaceIntList
- Overrides:
addAll
in classAbstractIntList
- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
addAll
Deprecated.Description copied from interface:IntList
Inserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).- Specified by:
addAll
in interfaceIntList
- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
removeAll
Deprecated.Description copied from interface:IntCollection
Remove from this collection all elements in the given type-specific collection.- Specified by:
removeAll
in interfaceIntCollection
- Overrides:
removeAll
in classAbstractIntCollection
- Parameters:
c
- a type-specific collection.- Returns:
true
if this collection changed as a result of the call.- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
retainAll
Deprecated.Description copied from interface:IntCollection
Retains in this collection only elements from the given type-specific collection.- Specified by:
retainAll
in interfaceIntCollection
- Overrides:
retainAll
in classAbstractIntCollection
- Parameters:
c
- a type-specific collection.- Returns:
true
if this collection changed as a result of the call.- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
set
Deprecated.Description copied from class:AbstractIntList
Replaces the element at the specified position in this list with the specified element (optional operation).- Specified by:
set
in interfaceIntList
- Overrides:
set
in classAbstractIntList
- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
clear
Deprecated.Description copied from class:AbstractIntList
- Specified by:
clear
in interfaceCollection<Integer>
- Specified by:
clear
in interfaceList<Integer>
- Overrides:
clear
in classAbstractIntList
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
size
Deprecated.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 interfaceIntList
- Overrides:
size
in classAbstractIntList
- Parameters:
size
- the new size.- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
removeElements
Deprecated.Description copied from class:AbstractIntList
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:
removeElements
in interfaceIntList
- Overrides:
removeElements
in classAbstractIntList
- Parameters:
from
- the start index (inclusive).to
- the end index (exclusive).- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
addElements
Deprecated.Description copied from class:AbstractIntList
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:
addElements
in interfaceIntList
- Overrides:
addElements
in classAbstractIntList
- 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.- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
setElements
Deprecated.Description copied from interface:IntList
Set (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:
setElements
in interfaceIntList
- Overrides:
setElements
in classAbstractIntList
- 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.- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
sort
Deprecated.Description copied from interface:IntList
Sort a list using a type-specific comparator.Pass
null
to sort using natural ordering.- Specified by:
sort
in interfaceIntList
- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
unstableSort
Deprecated.Description copied from interface:IntList
Sorts this list using a sort not assured to be stable.Pass
null
to sort using natural ordering.This differs from
List.sort(java.util.Comparator)
in that the results are not assured to be stable, but may be a bit faster.Unless a subclass specifies otherwise, the results of the method if the list is concurrently modified during the sort are unspecified.
- Specified by:
unstableSort
in interfaceIntList
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-
sort
Deprecated.Description copied from interface:IntList
-
unstableSort
Deprecated.Description copied from interface:IntList
Sorts this list using a sort not assured to be stable.- Specified by:
unstableSort
in interfaceIntList
- Implementation Specification:
- Always throws
UnsupportedOperationException
as this is an immutable type.
-