Class DoubleArrayList
- All Implemented Interfaces:
DoubleCollection,DoubleIterable,DoubleList,DoubleStack,Stack<Double>,Serializable,Cloneable,Comparable<List<? extends Double>>,Iterable<Double>,Collection<Double>,List<Double>,RandomAccess,SequencedCollection<Double>
This class implements a lightweight, fast, open, optimized, reuse-oriented version of array-based
lists. Instances of this class represent a list with an array that is enlarged as needed when new
entries are created (by increasing its current length by 50%), but is never made smaller
(even on a clear()). A family of trimming methods lets you control
the size of the backing array; this is particularly useful if you reuse instances of this class.
Range checks are equivalent to those of java.util's classes, but they are delayed as much
as possible. The backing array is exposed by the elements() method.
This class implements the bulk methods removeElements(), addElements() and
getElements() using high-performance system calls (e.g.,
System.arraycopy()) instead of expensive
loops.
- See Also:
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class it.unimi.dsi.fastutil.doubles.AbstractDoubleList
AbstractDoubleList.DoubleRandomAccessSubList, AbstractDoubleList.DoubleSubList -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe initial default capacity of an array list. -
Constructor Summary
ConstructorsConstructorDescriptionCreates a new array list withDEFAULT_INITIAL_CAPACITYcapacity.DoubleArrayList(double[] a) Creates a new array list and fills it with the elements of a given array.DoubleArrayList(double[] a, int offset, int length) Creates a new array list and fills it with the elements of a given array.DoubleArrayList(int capacity) Creates a new array list with given capacity.Creates a new array list and fills it with a given type-specific collection.Creates a new array list and fills it with the elements returned by a type-specific iterator..Creates a new array list and fills it with a given type-specific list.DoubleArrayList(Collection<? extends Double> c) Creates a new array list and fills it with a given collection.DoubleArrayList(Iterator<? extends Double> i) Creates a new array list and fills it with the elements returned by an iterator.. -
Method Summary
Modifier and TypeMethodDescriptionbooleanadd(double k) Ensures that this collection contains the specified element (optional operation).voidadd(int index, double k) Inserts the specified element at the specified position in this list (optional operation).booleanaddAll(int index, DoubleCollection 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, DoubleList l) Inserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).voidaddElements(int index, double[] a, int offset, int length) Adds elements to this type-specific list using optimized system calls.voidclear()clone()intCompares this array list to another array list.intCompares this list to another object.double[]elements()Returns the backing array of this list.voidensureCapacity(int capacity) Ensures that this array list can contain the given number of entries without resizing.booleanCompares this type-specific array list to another one.booleanvoidforEach(DoubleConsumer action) Performs the given action for each element of this type-specificIterableuntil all elements have been processed or the action throws an exception.doublegetDouble(int index) Returns the element at the specified position in this list.voidgetElements(int from, double[] a, int offset, int length) Copies element of this type-specific list into the given array using optimized system calls.intindexOf(double 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.booleanisEmpty()Checks whether the stack is empty.intlastIndexOf(double 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 DoubleArrayListof()Creates a new empty array list.static DoubleArrayListof(double... init) Creates an array list using an array of elements.booleanrem(double k) Removes a single instance of the specified element from this collection, if it is present (optional operation).booleanRemove from this collection all elements in the given type-specific collection.doubleremoveDouble(int index) Removes the element at the specified position in this list (optional operation).voidremoveElements(int from, int to) Removes elements of this type-specific list using optimized system calls.booleanremoveIf(DoublePredicate filter) Remove from this collection all elements which satisfy the given predicate.doubleset(int index, double k) Replaces the element at the specified position in this list with the specified element (optional operation).voidsetElements(int index, double[] a, int offset, int length) Sets elements to this type-specific list using optimized system calls.intsize()voidsize(int size) Sets the size of this list.voidsort(DoubleComparator comp) Sort a list using a type-specific comparator.Returns a type-specific spliterator on the elements of this collection.subList(int from, int to) Returns a type-specific view of the portion of this list from the indexfrom, inclusive, to the indexto, exclusive.double[]toArray(double[] 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.static DoubleArrayListtoList(DoubleStream stream) Collects the result of a primitiveStreaminto a new ArrayList.static DoubleArrayListtoListWithExpectedSize(DoubleStream stream, int expectedSize) Collects the result of a primitiveStreaminto a new ArrayList, potentially pre-allocated to handle the given size.voidtrim()Trims this array list so that the capacity is equal to the size.voidtrim(int n) Trims the backing array if it is too large.voidunstableSort(DoubleComparator comp) Sorts this list using a sort not assured to be stable.static DoubleArrayListwrap(double[] a) Wraps a given array into an array list.static DoubleArrayListwrap(double[] a, int length) Wraps a given array into an array list of given size.Methods inherited from class it.unimi.dsi.fastutil.doubles.AbstractDoubleList
addAll, addAll, addAll, addElements, contains, hashCode, iterator, listIterator, peekDouble, popDouble, push, replaceAll, toDoubleArray, topDouble, toStringMethods inherited from class it.unimi.dsi.fastutil.doubles.AbstractDoubleCollection
add, contains, containsAll, containsAll, forEach, remove, removeAll, removeIf, retainAll, retainAll, toDoubleArrayMethods inherited from class java.util.AbstractCollection
toArray, toArrayMethods inherited from interface java.util.Collection
toArrayMethods inherited from interface it.unimi.dsi.fastutil.doubles.DoubleCollection
containsAll, doubleIterator, doubleParallelStream, doubleSpliterator, doubleStream, parallelStream, removeIf, removeIf, retainAll, stream, toDoubleArrayMethods inherited from interface it.unimi.dsi.fastutil.doubles.DoubleIterable
forEach, forEachMethods inherited from interface it.unimi.dsi.fastutil.doubles.DoubleList
add, add, addAll, contains, get, indexOf, lastIndexOf, remove, remove, replaceAll, replaceAll, set, setElements, setElements, sort, unstableSortMethods inherited from interface it.unimi.dsi.fastutil.doubles.DoubleStack
peek, pop, push, topMethods inherited from interface java.util.List
addFirst, addLast, containsAll, getFirst, getLast, removeAll, removeFirst, removeLast, retainAll, reversed, toArray, toArray
-
Field Details
-
DEFAULT_INITIAL_CAPACITY
public static final int DEFAULT_INITIAL_CAPACITYThe initial default capacity of an array list.- See Also:
-
-
Constructor Details
-
DoubleArrayList
public DoubleArrayList(int capacity) Creates a new array list with given capacity.- Parameters:
capacity- the initial capacity of the array list (may be 0).
-
DoubleArrayList
public DoubleArrayList()Creates a new array list withDEFAULT_INITIAL_CAPACITYcapacity. -
DoubleArrayList
Creates a new array list and fills it with a given collection.- Parameters:
c- a collection that will be used to fill the array list.
-
DoubleArrayList
Creates a new array list and fills it with a given type-specific collection.- Parameters:
c- a type-specific collection that will be used to fill the array list.
-
DoubleArrayList
Creates a new array list and fills it with a given type-specific list.- Parameters:
l- a type-specific list that will be used to fill the array list.
-
DoubleArrayList
public DoubleArrayList(double[] a) Creates a new array list and fills it with the elements of a given array.- Parameters:
a- an array whose elements will be used to fill the array list.
-
DoubleArrayList
public DoubleArrayList(double[] a, int offset, int length) Creates a new array list and fills it with the elements of a given array.- Parameters:
a- an array whose elements will be used to fill the array list.offset- the first element to use.length- the number of elements to use.
-
DoubleArrayList
-
DoubleArrayList
Creates a new array 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 array list.
-
-
Method Details
-
elements
public double[] elements()Returns the backing array of this list.- Returns:
- the backing array.
-
wrap
Wraps a given array into an array list of given size.Note it is guaranteed that the type of the array returned by
elements()will be the same (see the comments in the class documentation).- Parameters:
a- an array to wrap.length- the length of the resulting array list.- Returns:
- a new array list of the given size, wrapping the given array.
-
wrap
Wraps a given array into an array list.Note it is guaranteed that the type of the array returned by
elements()will be the same (see the comments in the class documentation).- Parameters:
a- an array to wrap.- Returns:
- a new array list wrapping the given array.
-
of
-
of
Creates an array list using an array of elements.- Parameters:
init- a the array the will become the new backing array of the array list.- Returns:
- a new array list backed by the given array.
- See Also:
-
toList
Collects the result of a primitiveStreaminto a new ArrayList.This method performs a terminal operation on the given
Stream- API Notes:
- Taking a primitive stream instead of returning something like a
Collectoris necessary because there is no primitiveCollectorequivalent in the Java API.
-
toListWithExpectedSize
Collects the result of a primitiveStreaminto a new ArrayList, 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
Collectoris necessary because there is no primitiveCollectorequivalent in the Java API.
-
ensureCapacity
public void ensureCapacity(int capacity) Ensures that this array list can contain the given number of entries without resizing.- Parameters:
capacity- the new minimum capacity for this array list.
-
add
public void add(int index, double k) Description copied from class:AbstractDoubleListInserts the specified element at the specified position in this list (optional operation).- Specified by:
addin interfaceDoubleList- Overrides:
addin classAbstractDoubleList- See Also:
-
add
public boolean add(double k) Description copied from class:AbstractDoubleListEnsures that this collection contains the specified element (optional operation).- Specified by:
addin interfaceDoubleCollection- Specified by:
addin interfaceDoubleList- Overrides:
addin classAbstractDoubleList- See Also:
-
getDouble
public double getDouble(int index) Description copied from interface:DoubleListReturns the element at the specified position in this list.- Specified by:
getDoublein interfaceDoubleList- See Also:
-
indexOf
public int indexOf(double k) Description copied from interface:DoubleListReturns 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:
indexOfin interfaceDoubleList- Overrides:
indexOfin classAbstractDoubleList- See Also:
-
lastIndexOf
public int lastIndexOf(double k) Description copied from interface:DoubleListReturns 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 interfaceDoubleList- Overrides:
lastIndexOfin classAbstractDoubleList- See Also:
-
removeDouble
public double removeDouble(int index) Description copied from class:AbstractDoubleListRemoves the element at the specified position in this list (optional operation).- Specified by:
removeDoublein interfaceDoubleList- Overrides:
removeDoublein classAbstractDoubleList- See Also:
-
rem
public boolean rem(double k) Description copied from class:AbstractDoubleListRemoves a single instance of the specified element from this collection, if it is present (optional operation).- Specified by:
remin interfaceDoubleCollection- Overrides:
remin classAbstractDoubleList- See Also:
-
set
public double set(int index, double k) Description copied from class:AbstractDoubleListReplaces the element at the specified position in this list with the specified element (optional operation).- Specified by:
setin interfaceDoubleList- Overrides:
setin classAbstractDoubleList- See Also:
-
clear
public void clear()Description copied from class:AbstractDoubleList- Specified by:
clearin interfaceCollection<Double>- Specified by:
clearin interfaceList<Double>- Overrides:
clearin classAbstractDoubleList
-
size
public int size()- Specified by:
sizein interfaceCollection<Double>- Specified by:
sizein interfaceList<Double>- Specified by:
sizein classAbstractCollection<Double>
-
size
public void size(int size) Description copied from interface:DoubleListSets 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:
sizein interfaceDoubleList- Overrides:
sizein classAbstractDoubleList- Parameters:
size- the new size.
-
isEmpty
public boolean isEmpty()Description copied from interface:StackChecks whether the stack is empty. -
trim
public void trim()Trims this array list so that the capacity is equal to the size.- See Also:
-
trim
public void trim(int n) Trims the backing array if it is too large. If the current array length is smaller than or equal ton, this method does nothing. Otherwise, it trims the array length to the maximum betweennandsize().This method is useful when reusing lists. Clearing a list leaves the array length untouched. If you are reusing a list many times, you can call this method with a typical size to avoid keeping around a very large array just because of a few large transient lists.
- Parameters:
n- the threshold for the trimming.
-
subList
Description copied from interface:DoubleListReturns a type-specific view of the portion of this list from the indexfrom, inclusive, to the indexto, exclusive.- Specified by:
subListin interfaceDoubleList- Specified by:
subListin interfaceList<Double>- Overrides:
subListin classAbstractDoubleList- See Also:
-
getElements
public void getElements(int from, double[] a, int offset, int length) Copies element of this type-specific list into the given array using optimized system calls.- Specified by:
getElementsin interfaceDoubleList- Overrides:
getElementsin classAbstractDoubleList- 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.
-
removeElements
public void removeElements(int from, int to) Removes elements of this type-specific list using optimized system calls.- Specified by:
removeElementsin interfaceDoubleList- Overrides:
removeElementsin classAbstractDoubleList- Parameters:
from- the start index (inclusive).to- the end index (exclusive).
-
addElements
public void addElements(int index, double[] a, int offset, int length) Adds elements to this type-specific list using optimized system calls.- Specified by:
addElementsin interfaceDoubleList- Overrides:
addElementsin classAbstractDoubleList- 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.
-
setElements
public void setElements(int index, double[] a, int offset, int length) Sets elements to this type-specific list using optimized system calls.- Specified by:
setElementsin interfaceDoubleList- Overrides:
setElementsin classAbstractDoubleList- Parameters:
index- the index at which to start setting elements.a- the array containing the elements.offset- the offset of the first element to add.length- the number of elements to add.
-
forEach
Description copied from class:AbstractDoubleListPerforms the given action for each element of this type-specificIterableuntil all elements have been processed or the action throws an exception.- Specified by:
forEachin interfaceDoubleIterable- Overrides:
forEachin classAbstractDoubleList- Parameters:
action- the action to be performed for each element.- See Also:
-
addAll
Description copied from interface:DoubleListInserts all of the elements in the specified type-specific collection into this type-specific list at the specified position (optional operation).- Specified by:
addAllin interfaceDoubleList- Overrides:
addAllin classAbstractDoubleList- See Also:
-
addAll
Description copied from interface:DoubleListInserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).- Specified by:
addAllin interfaceDoubleList- See Also:
-
removeAll
Description copied from interface:DoubleCollectionRemove from this collection all elements in the given type-specific collection.- Specified by:
removeAllin interfaceDoubleCollection- Overrides:
removeAllin classAbstractDoubleCollection- Parameters:
c- a type-specific collection.- Returns:
trueif this collection changed as a result of the call.- See Also:
-
removeIf
Description copied from interface:DoubleCollectionRemove from this collection all elements which satisfy the given predicate.- Specified by:
removeIfin interfaceDoubleCollection- Parameters:
filter- a predicate which returnstruefor elements to be removed.- Returns:
trueif any elements were removed.- See Also:
-
toArray
public double[] toArray(double[] a) Description copied from interface:DoubleCollectionReturns 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 interfaceDoubleCollection- Overrides:
toArrayin classAbstractDoubleList- 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:AbstractDoubleListReturns a type-specific list iterator on the list starting at a given index.- Specified by:
listIteratorin interfaceDoubleList- Specified by:
listIteratorin interfaceList<Double>- Overrides:
listIteratorin classAbstractDoubleList- See Also:
-
spliterator
Returns a type-specific spliterator on the elements of this collection.See
Collection.spliterator()for more documentation on the requirements of the returned spliterator.The returned spliterator is late-binding; it will track structural changes after the current index, up until the first
trySplit(), at which point the maximum index will be fixed.
Structural changes before the current index or after the firsttrySplit()will result in unspecified behavior.- Specified by:
spliteratorin interfaceCollection<Double>- Specified by:
spliteratorin interfaceDoubleCollection- Specified by:
spliteratorin interfaceDoubleIterable- Specified by:
spliteratorin interfaceDoubleList- Specified by:
spliteratorin interfaceIterable<Double>- Specified by:
spliteratorin interfaceList<Double>- Returns:
- a type-specific spliterator on the elements of this collection.
-
sort
Description copied from interface:DoubleListSort a list using a type-specific comparator.Pass
nullto sort using natural ordering.- Specified by:
sortin interfaceDoubleList- See Also:
-
unstableSort
Description copied from interface:DoubleListSorts this list using a sort not assured to be stable.Pass
nullto 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:
unstableSortin interfaceDoubleList
-
clone
-
equals
Compares this type-specific array list to another one.- Parameters:
l- a type-specific array list.- Returns:
- true if the argument contains the same elements of this type-specific array list.
- API Notes:
- This method exists only for sake of efficiency. The implementation inherited from the abstract implementation would already work.
-
equals
- Specified by:
equalsin interfaceCollection<Double>- Specified by:
equalsin interfaceList<Double>- Overrides:
equalsin classAbstractDoubleList
-
compareTo
Compares this array list to another array list.- Parameters:
l- an array 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:AbstractDoubleListCompares 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 Double>>- Overrides:
compareToin classAbstractDoubleList- 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.
-