Package it.unimi.dsi.fastutil.doubles

Class DoubleBigArrayBigList

java.lang.Object

java.util.AbstractCollection<Double>

it.unimi.dsi.fastutil.doubles.AbstractDoubleCollection

it.unimi.dsi.fastutil.doubles.AbstractDoubleBigList

it.unimi.dsi.fastutil.doubles.DoubleBigArrayBigList

All Implemented Interfaces:

BigList<Double>, DoubleBigList, DoubleCollection, DoubleIterable, DoubleStack, Size64, Stack<Double>, Serializable, Cloneable, Comparable<BigList<? extends Double>>, Iterable<Double>, Collection<Double>, RandomAccess

public class DoubleBigArrayBigList
extends AbstractDoubleBigList
implements RandomAccess, Cloneable, Serializable

A type-specific big list based on a big array; provides some additional methods that use polymorphism to avoid (un)boxing.

This class implements a lightweight, fast, open, optimized, reuse-oriented version of big-array-based big lists. Instances of this class represent a big list with a big 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 big 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 big 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:

• ArrayList
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.doubles.AbstractDoubleBigList

AbstractDoubleBigList.DoubleRandomAccessSubList, AbstractDoubleBigList.DoubleSubList

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_INITIAL_CAPACITY	The initial default capacity of a big-array big list.

Constructor Summary

Constructors

Constructor	Description
DoubleBigArrayBigList()	Creates a new big-array big list with DEFAULT_INITIAL_CAPACITY capacity.
DoubleBigArrayBigList(double[][] a)	Creates a new big-array big list and fills it with the elements of a given big array.
DoubleBigArrayBigList(double[][] a, long offset, long length)	Creates a new big-array big list and fills it with the elements of a given big array.
DoubleBigArrayBigList(long capacity)	Creates a new big-array big list with given capacity.
DoubleBigArrayBigList(DoubleBigList l)	Creates a new big-array big list and fills it with a given type-specific list.
DoubleBigArrayBigList(DoubleCollection c)	Creates a new big-array big list and fills it with a given type-specific collection.
DoubleBigArrayBigList(DoubleIterator i)	Creates a new big-array big list and fills it with the elements returned by a type-specific iterator..
DoubleBigArrayBigList(Iterator<? extends Double> i)	Creates a new big-array big list and fills it with the elements returned by an iterator..

Method Summary

Modifier and Type	Method	Description
boolean	add(double k)	Ensures that this collection contains the specified element (optional operation).
void	add(long index, double k)	Inserts the specified element at the specified position in this type-specific big list (optional operation).
boolean	addAll(long index, DoubleBigList list)	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, DoubleCollection c)	Inserts all of the elements in the specified type-specific collection into this type-specific big list at the specified position (optional operation).
boolean	addAll(long index, DoubleList list)	Inserts all of the elements in the specified type-specific list into this type-specific big list at the specified position (optional operation).
void	addElements(long index, double[][] a, long offset, long length)	Adds elements to this type-specific list using optimized system calls.
void	clear()
DoubleBigArrayBigList	clone()
int	compareTo(BigList<? extends Double> l)	Compares this big list to another object.
int	compareTo(DoubleBigArrayBigList l)	Compares this big list to another big list.
double[][]	elements()	Returns the backing big array of this big list.
void	ensureCapacity(long capacity)	Ensures that this big-array big list can contain the given number of entries without resizing.
boolean	equals(DoubleBigArrayBigList l)	Compares this type-specific big-array list to another one.
boolean	equals(Object o)
void	forEach(DoubleConsumer action)	Performs the given action for each element of this type-specific Iterable until all elements have been processed or the action throws an exception.
double	getDouble(long index)	Returns the element at the specified position.
void	getElements(long from, double[][] a, long offset, long length)	Copies element of this type-specific list into the given big array using optimized system calls.
void	getElements(long from, double[] a, int offset, int length)	Copies element of this type-specific list into the given array using optimized system calls.
long	indexOf(double 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.
boolean	isEmpty()	Checks whether the stack is empty.
long	lastIndexOf(double 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.
DoubleBigListIterator	listIterator(long index)	Returns a type-specific list iterator on this type-specific big list starting at a given index.
static DoubleBigArrayBigList	of()	Creates a new empty big array list.
static DoubleBigArrayBigList	of(double... init)	Creates a big array list using a list of elements.
boolean	rem(double k)	Removes a single instance of the specified element from this collection, if it is present (optional operation).
boolean	removeAll(DoubleCollection c)	Remove from this collection all elements in the given type-specific collection.
boolean	removeAll(Collection<?> c)
double	removeDouble(long index)	Removes the element at the specified position.
void	removeElements(long from, long to)	Removes elements of this type-specific list using optimized system calls.
double	set(long index, double k)	Replaces the element at the specified position in this big list with the specified element (optional operation).
void	setElements(long index, double[][] a, long offset, long length)	Copies elements in the given big array into this type-specific list using optimized system calls.
void	size(long size)	Sets the size of this big list.
long	size64()	Returns the size of this data structure as a long.
DoubleSpliterator	spliterator()	Returns a type-specific spliterator on the elements of this big-list.
DoubleBigList	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.
static DoubleBigArrayBigList	toBigList(DoubleStream stream)	Collects the result of a primitive Stream into a new BigArrayBigList.
static DoubleBigArrayBigList	toBigListWithExpectedSize(DoubleStream stream, long expectedSize)	Collects the result of a primitive Stream into a new BigArrayBigList.
void	trim()	Trims this big-array big list so that the capacity is equal to the size.
void	trim(long n)	Trims the backing big array if it is too large.
static DoubleBigArrayBigList	wrap(double[][] a)	Wraps a given big array into a big-array big list.
static DoubleBigArrayBigList	wrap(double[][] a, long length)	Wraps a given big array into a big-array list of given size.

Methods inherited from class it.unimi.dsi.fastutil.doubles.AbstractDoubleBigList

add, addAll, addAll, addAll, addElements, contains, get, hashCode, indexOf, iterator, lastIndexOf, listIterator, peek, peekDouble, pop, popDouble, push, push, remove, set, size, top, topDouble, toString

Methods inherited from class it.unimi.dsi.fastutil.doubles.AbstractDoubleCollection

add, contains, containsAll, containsAll, forEach, remove, removeIf, retainAll, retainAll, toArray, toDoubleArray, toDoubleArray

Methods inherited from class java.util.AbstractCollection

toArray, toArray

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

containsAll, retainAll, toArray, toArray, toArray

Methods inherited from interface it.unimi.dsi.fastutil.doubles.DoubleBigList

addAll, addAll, setElements, setElements

Methods inherited from interface it.unimi.dsi.fastutil.doubles.DoubleCollection

add, contains, containsAll, doubleIterator, doubleParallelStream, doubleSpliterator, doubleStream, parallelStream, remove, removeIf, removeIf, removeIf, retainAll, stream, toArray, toDoubleArray, toDoubleArray

Methods inherited from interface it.unimi.dsi.fastutil.doubles.DoubleIterable

forEach, forEach

Field Details

DEFAULT_INITIAL_CAPACITY

public static final int DEFAULT_INITIAL_CAPACITY

The initial default capacity of a big-array big list.

See Also:

• Constant Field Values

Constructor Details

DoubleBigArrayBigList

public DoubleBigArrayBigList(long capacity)

Creates a new big-array big list with given capacity.

Parameters:

capacity - the initial capacity of the array list (may be 0).

DoubleBigArrayBigList

public DoubleBigArrayBigList()

Creates a new big-array big list with DEFAULT_INITIAL_CAPACITY capacity.

DoubleBigArrayBigList

public DoubleBigArrayBigList(DoubleCollection c)

Creates a new big-array big 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.

DoubleBigArrayBigList

public DoubleBigArrayBigList(DoubleBigList l)

Creates a new big-array big 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.

DoubleBigArrayBigList

public DoubleBigArrayBigList(double[][] a)

Creates a new big-array big list and fills it with the elements of a given big array.

Parameters:

a - a big array whose elements will be used to fill the array list.

DoubleBigArrayBigList

public DoubleBigArrayBigList(double[][] a,
 long offset,
 long length)

Creates a new big-array big list and fills it with the elements of a given big array.

Parameters:

a - a big array whose elements will be used to fill the array list.

offset - the first element to use.

length - the number of elements to use.

DoubleBigArrayBigList

public DoubleBigArrayBigList(Iterator<? extends Double> i)

Creates a new big-array big list and fills it with the elements returned by an iterator..

Parameters:

i - an iterator whose returned elements will fill the array list.

DoubleBigArrayBigList

public DoubleBigArrayBigList(DoubleIterator i)

Creates a new big-array big 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 big array of this big list.

Returns:

the backing big array.

wrap

public static DoubleBigArrayBigList wrap(double[][] a,
 long length)

Wraps a given big array into a big-array list of given size.

Parameters:

a - a big array to wrap.

length - the length of the resulting big-array list.

Returns:

a new big-array list of the given size, wrapping the given big array.

wrap

public static DoubleBigArrayBigList wrap(double[][] a)

Wraps a given big array into a big-array big list.

Parameters:

a - a big array to wrap.

Returns:

a new big-array big list wrapping the given array.

of

public static DoubleBigArrayBigList of()

Creates a new empty big array list.

Returns:

a new empty big-array big list.

of

public static DoubleBigArrayBigList of(double... init)

Creates a big array list using a list of elements.

Parameters:

init - a list of elements that will be used to initialize the big list. It is possible (but not assured) that the returned big-array big list will be backed by the given array in one of its segments.

Returns:

a new big-array big list containing the given elements.

See Also:

• BigArrays.wrap(byte[])

toBigList

public static DoubleBigArrayBigList toBigList(DoubleStream stream)

Collects the result of a primitive Stream into a new BigArrayBigList.

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 primitive Collector equivalent in the Java API.

toBigListWithExpectedSize

public static DoubleBigArrayBigList toBigListWithExpectedSize(DoubleStream stream,
 long expectedSize)

Collects the result of a primitive Stream into a new BigArrayBigList.

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 primitive Collector equivalent in the Java API.

Implementation Notes:

The current implementation preallocates the full size for every worker thread when used on parallel streams. This can be quite wasteful, as worker threads other then the first don't usually handle the contents of the full stream.

ensureCapacity

public void ensureCapacity(long capacity)

Ensures that this big-array big list can contain the given number of entries without resizing.

Parameters:

capacity - the new minimum capacity for this big-array big list.

add

public void add(long index,
 double k)

Description copied from class: AbstractDoubleBigList

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

Specified by:

add in interface DoubleBigList

Overrides:

add in class AbstractDoubleBigList

See Also:

• BigList.add(long,Object)

add

public boolean add(double k)

Description copied from class: AbstractDoubleBigList

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

Specified by:

add in interface DoubleCollection

Overrides:

add in class AbstractDoubleBigList

See Also:

• Collection.add(Object)

getDouble

public double getDouble(long index)

Description copied from interface: DoubleBigList

Returns the element at the specified position.

Specified by:

getDouble in interface DoubleBigList

See Also:

• BigList.get(long)

indexOf

public long indexOf(double k)

Description copied from interface: DoubleBigList

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 DoubleBigList

Overrides:

indexOf in class AbstractDoubleBigList

See Also:

• BigList.indexOf(Object)

lastIndexOf

public long lastIndexOf(double k)

Description copied from interface: DoubleBigList

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 DoubleBigList

Overrides:

lastIndexOf in class AbstractDoubleBigList

See Also:

• BigList.lastIndexOf(Object)

removeDouble

public double removeDouble(long index)

Description copied from class: AbstractDoubleBigList

Removes the element at the specified position.

Specified by:

removeDouble in interface DoubleBigList

Overrides:

removeDouble in class AbstractDoubleBigList

See Also:

• BigList.remove(long)

rem

public boolean rem(double k)

Description copied from class: AbstractDoubleBigList

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

Specified by:

rem in interface DoubleCollection

Overrides:

rem in class AbstractDoubleBigList

See Also:

• Collection.remove(Object)

set

public double set(long index,
 double k)

Description copied from class: AbstractDoubleBigList

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

Specified by:

set in interface DoubleBigList

Overrides:

set in class AbstractDoubleBigList

See Also:

• BigList.set(long,Object)

removeAll

public boolean removeAll(DoubleCollection c)

Description copied from interface: DoubleCollection

Remove from this collection all elements in the given type-specific collection.

Specified by:

removeAll in interface DoubleCollection

Overrides:

removeAll in class AbstractDoubleCollection

Parameters:

c - a type-specific collection.

Returns:

true if this collection changed as a result of the call.

See Also:

• Collection.removeAll(Collection)

removeAll

public boolean removeAll(Collection<?> c)

Description copied from class: AbstractDoubleCollection

Specified by:

removeAll in interface Collection<Double>

Overrides:

removeAll in class AbstractDoubleCollection

addAll

public boolean addAll(long index,
 DoubleCollection c)

Description copied from class: AbstractDoubleBigList

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

Specified by:

addAll in interface DoubleBigList

Overrides:

addAll in class AbstractDoubleBigList

See Also:

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

addAll

public boolean addAll(long index,
 DoubleBigList list)

Description copied from interface: DoubleBigList

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

Specified by:

addAll in interface DoubleBigList

See Also:

• BigList.addAll(long,Collection)

addAll

public boolean addAll(long index,
 DoubleList list)

Description copied from interface: DoubleBigList

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

Specified by:

addAll in interface DoubleBigList

See Also:

• BigList.addAll(long,Collection)

clear

public void clear()

Description copied from class: AbstractDoubleBigList

Specified by:

clear in interface Collection<Double>

Overrides:

clear in class AbstractDoubleBigList

size64

public long size64()

Description copied from interface: Size64

Returns the size of this data structure as a long.

Specified by:

size64 in interface Size64

Returns:

the size of this data structure.

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

Overrides:

size in class AbstractDoubleBigList

Parameters:

size - the new size.

isEmpty

public boolean isEmpty()

Description copied from interface: Stack

Checks whether the stack is empty.

Specified by:

isEmpty in interface Collection<Double>

Specified by:

isEmpty in interface Stack<Double>

Overrides:

isEmpty in class AbstractCollection<Double>

Returns:

true if the stack is empty.

trim

public void trim()

Trims this big-array big list so that the capacity is equal to the size.

See Also:

• ArrayList.trimToSize()

trim

public void trim(long n)

Trims the backing big array if it is too large. If the current big array length is smaller than or equal to n, this method does nothing. Otherwise, it trims the big-array length to the maximum between n and size64().

This method is useful when reusing big lists. Clearing a big list leaves the big-array length untouched. If you are reusing a big list many times, you can call this method with a typical size to avoid keeping around a very large big array just because of a few large transient big lists.

Parameters:

n - the threshold for the trimming.

subList

public DoubleBigList subList(long from,
 long to)

Description copied from interface: DoubleBigList

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 BigList<Double>

Specified by:

subList in interface DoubleBigList

Overrides:

subList in class AbstractDoubleBigList

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)

getElements

public void getElements(long from,
 double[][] a,
 long offset,
 long length)

Copies element of this type-specific list into the given big array using optimized system calls.

Specified by:

getElements in interface DoubleBigList

Overrides:

getElements in class AbstractDoubleBigList

Parameters:

from - the start index (inclusive).

a - the destination big array.

offset - the offset into the destination array where to store the first element copied.

length - the number of elements to be copied.

getElements

public void getElements(long from,
 double[] a,
 int offset,
 int length)

Copies element of this type-specific list into the given array using optimized system calls.

Specified by:

getElements in interface DoubleBigList

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(long from,
 long to)

Removes elements of this type-specific list using optimized system calls.

Specified by:

removeElements in interface DoubleBigList

Overrides:

removeElements in class AbstractDoubleBigList

Parameters:

from - the start index (inclusive).

to - the end index (exclusive).

addElements

public void addElements(long index,
 double[][] a,
 long offset,
 long length)

Adds elements to this type-specific list using optimized system calls.

Specified by:

addElements in interface DoubleBigList

Overrides:

addElements in class AbstractDoubleBigList

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.

setElements

public void setElements(long index,
 double[][] a,
 long offset,
 long length)

Copies elements in the given big array into this type-specific list using optimized system calls.

Specified by:

setElements in interface DoubleBigList

Overrides:

setElements in class AbstractDoubleBigList

Parameters:

index - the start index (inclusive).

a - the destination big array.

offset - the offset into the destination array where to store the first element copied.

length - the number of elements to be copied.

forEach

public void forEach(DoubleConsumer action)

Description copied from class: AbstractDoubleBigList

Performs the given action for each element of this type-specific Iterable until all elements have been processed or the action throws an exception.

Specified by:

forEach in interface DoubleIterable

Overrides:

forEach in class AbstractDoubleBigList

Parameters:

action - the action to be performed for each element.

See Also:

• Iterable.forEach(java.util.function.Consumer)

listIterator

public DoubleBigListIterator listIterator(long index)

Description copied from class: AbstractDoubleBigList

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

Specified by:

listIterator in interface BigList<Double>

Specified by:

listIterator in interface DoubleBigList

Overrides:

listIterator in class AbstractDoubleBigList

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)

spliterator

public DoubleSpliterator spliterator()

Description copied from interface: DoubleBigList

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

BigList spliterators must report at least Spliterator.SIZED and Spliterator.ORDERED.

See List.spliterator() for more documentation on the requirements of the returned spliterator (despite BigList not being a List, most of the same requirements apply.

Specified by:

spliterator in interface Collection<Double>

Specified by:

spliterator in interface DoubleBigList

Specified by:

spliterator in interface DoubleCollection

Specified by:

spliterator in interface DoubleIterable

Specified by:

spliterator in interface Iterable<Double>

Returns:

a type-specific spliterator on the elements of this collection.

clone

public DoubleBigArrayBigList clone()

equals

public boolean equals(DoubleBigArrayBigList l)

Compares this type-specific big-array list to another one.

This method exists only for sake of efficiency. The implementation inherited from the abstract implementation would already work.

Parameters:

l - a type-specific big-array list.

Returns:

true if the argument contains the same elements of this type-specific big-array list.

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<Double>

Overrides:

equals in class AbstractDoubleBigList

compareTo

public int compareTo(DoubleBigArrayBigList l)

Compares this big list to another big list.

This method exists only for sake of efficiency. The implementation inherited from the abstract implementation would already work.

Parameters:

l - a big list.

Returns:

a negative integer, zero, or a positive integer as this big list is lexicographically less than, equal to, or greater than the argument.

compareTo

public int compareTo(BigList<? extends Double> l)

Description copied from class: AbstractDoubleBigList

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

Overrides:

compareTo in class AbstractDoubleBigList

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.