Class ReferenceBigArrayBigList<K>
- java.lang.Object
-
- java.util.AbstractCollection<K>
-
- it.unimi.dsi.fastutil.objects.AbstractReferenceCollection<K>
-
- it.unimi.dsi.fastutil.objects.AbstractReferenceBigList<K>
-
- it.unimi.dsi.fastutil.objects.ReferenceBigArrayBigList<K>
-
- All Implemented Interfaces:
BigList<K>
,ObjectIterable<K>
,ReferenceBigList<K>
,ReferenceCollection<K>
,Size64
,Stack<K>
,java.io.Serializable
,java.lang.Cloneable
,java.lang.Iterable<K>
,java.util.Collection<K>
,java.util.RandomAccess
public class ReferenceBigArrayBigList<K> extends AbstractReferenceBigList<K> implements java.util.RandomAccess, java.lang.Cloneable, java.io.Serializable
A type-specific big-array-based big list; 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 doubling the current length), 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 ofjava.util
's classes, but they are delayed as much as possible.The backing big array is exposed by the
elements()
method. If an instance of this class was created by wrapping, backing-array reallocations will be performed using reflection, so thatelements()
can return a big array of the same type of the original big array; the comments about efficiency made inObjectArrays
apply here.This class implements the bulk methods
removeElements()
,addElements()
andgetElements()
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.objects.AbstractReferenceBigList
AbstractReferenceBigList.ReferenceSubList<K>
-
-
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_INITIAL_CAPACITY
The initial default capacity of a big-array big list.
-
Constructor Summary
Constructors Constructor Description ReferenceBigArrayBigList()
Creates a new big-array big list withDEFAULT_INITIAL_CAPACITY
capacity.ReferenceBigArrayBigList(long capacity)
Creates a new big-array big list with given capacity.ReferenceBigArrayBigList(ObjectIterator<? extends K> i)
Creates a new big-array big list and fills it with the elements returned by a type-specific iterator..ReferenceBigArrayBigList(ReferenceBigList<? extends K> l)
Creates a new big-array big list and fills it with a given type-specific list.ReferenceBigArrayBigList(ReferenceCollection<? extends K> c)
Creates a new big-array big list and fills it with a given type-specific collection.ReferenceBigArrayBigList(java.util.Iterator<? extends K> i)
Creates a new big-array big list and fills it with the elements returned by an iterator..ReferenceBigArrayBigList(K[][] a)
Creates a new big-array big list and fills it with the elements of a given big array.ReferenceBigArrayBigList(K[][] a, long offset, long length)
Creates a new big-array big list and fills it with the elements of a given big array.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
add(long index, K k)
Inserts the specified element at the specified position in this big list (optional operation).boolean
add(K k)
void
addElements(long index, K[][] a, long offset, long length)
Adds elements to this type-specific list using optimized system calls.void
clear()
ReferenceBigArrayBigList<K>
clone()
K[][]
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(ReferenceBigArrayBigList<K> l)
Compares this type-specific big-array list to another one.K
get(long index)
Returns the element at the specified position.void
getElements(long from, java.lang.Object[][] a, long offset, long length)
Copies element of this type-specific list into the given big array using optimized system calls.long
indexOf(java.lang.Object k)
Returns the index of the first occurrence of the specified element in this big list, or -1 if this big list does not contain the element.boolean
isEmpty()
Checks whether the stack is empty.long
lastIndexOf(java.lang.Object k)
Returns the index of the last occurrence of the specified element in this big list, or -1 if this big list does not contain the element.ObjectBigListIterator<K>
listIterator(long index)
Returns a type-specific list iterator on this type-specific big list starting at a given index.static <K> ReferenceBigArrayBigList<K>
of(K... init)
Creates a big array list using a list of elements.K
remove(long index)
Removes the element at the specified position.boolean
remove(java.lang.Object k)
boolean
removeAll(java.util.Collection<?> c)
void
removeElements(long from, long to)
Removes elements of this type-specific list using optimized system calls.K
set(long index, K k)
Replaces the element at the specified position in this big list with the specified element (optional operation).void
size(long size)
Sets the size of this big list.long
size64()
Returns the size of this data structure as a long.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 <K> ReferenceBigArrayBigList<K>
wrap(K[][] a)
Wraps a given big array into a big-array big list.static <K> ReferenceBigArrayBigList<K>
wrap(K[][] a, long length)
Wraps a given big array into a big-array list of given size.-
Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractReferenceBigList
addAll, addAll, addElements, contains, equals, hashCode, iterator, listIterator, peek, pop, push, size, subList, top, toString
-
-
-
-
Field Detail
-
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 Detail
-
ReferenceBigArrayBigList
public ReferenceBigArrayBigList(long capacity)
Creates a new big-array big list with given capacity.- Parameters:
capacity
- the initial capacity of the array list (may be 0).
-
ReferenceBigArrayBigList
public ReferenceBigArrayBigList()
Creates a new big-array big list withDEFAULT_INITIAL_CAPACITY
capacity.
-
ReferenceBigArrayBigList
public ReferenceBigArrayBigList(ReferenceCollection<? extends K> 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.
-
ReferenceBigArrayBigList
public ReferenceBigArrayBigList(ReferenceBigList<? extends K> 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.
-
ReferenceBigArrayBigList
public ReferenceBigArrayBigList(K[][] a)
Creates a new big-array big list and fills it with the elements of a given big array.Note that this constructor makes it easy to build big lists from literal arrays declared as
type[][] {{ init_values }}
. The only constraint is that the number of initialisation values is belowBigArrays.SEGMENT_SIZE
.- Parameters:
a
- a big array whose elements will be used to fill the array list.
-
ReferenceBigArrayBigList
public ReferenceBigArrayBigList(K[][] a, long offset, long length)
Creates a new big-array big list and fills it with the elements of a given big array.Note that this constructor makes it easy to build big lists from literal arrays declared as
type[][] {{ init_values }}
. The only constraint is that the number of initialisation values is belowBigArrays.SEGMENT_SIZE
.- 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.
-
ReferenceBigArrayBigList
public ReferenceBigArrayBigList(java.util.Iterator<? extends K> 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.
-
ReferenceBigArrayBigList
public ReferenceBigArrayBigList(ObjectIterator<? extends K> 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 Detail
-
elements
public K[][] elements()
Returns the backing big array of this big list.If this big-array big list was created by wrapping a given big array, it is guaranteed that the type of the returned big array will be the same. Otherwise, the returned big array will be an big array of objects.
- Returns:
- the backing big array.
-
wrap
public static <K> ReferenceBigArrayBigList<K> wrap(K[][] 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 <K> ReferenceBigArrayBigList<K> wrap(K[][] 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
@SafeVarargs public static <K> ReferenceBigArrayBigList<K> of(K... 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.- Returns:
- a new big-array big list containing the given elements.
-
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, K k)
Description copied from class:AbstractReferenceBigList
Inserts the specified element at the specified position in this big list (optional operation).This implementation always throws an
UnsupportedOperationException
.
-
add
public boolean add(K k)
Description copied from class:AbstractReferenceBigList
This implementation delegates to the type-specific version of
BigList.add(long, Object)
.- Specified by:
add
in interfacejava.util.Collection<K>
- Overrides:
add
in classAbstractReferenceBigList<K>
-
get
public K get(long index)
Description copied from interface:BigList
Returns the element at the specified position.
-
indexOf
public long indexOf(java.lang.Object k)
Description copied from interface:BigList
Returns the index of the first occurrence of the specified element in this big list, or -1 if this big list does not contain the element.- Specified by:
indexOf
in interfaceBigList<K>
- Overrides:
indexOf
in classAbstractReferenceBigList<K>
- Parameters:
k
- the object to search for.- Returns:
- the index of the first occurrence of the specified element in this big list, or -1 if this big list does not contain the element.
- See Also:
List.indexOf(Object)
-
lastIndexOf
public long lastIndexOf(java.lang.Object k)
Description copied from interface:BigList
Returns the index of the last occurrence of the specified element in this big list, or -1 if this big list does not contain the element.- Specified by:
lastIndexOf
in interfaceBigList<K>
- Overrides:
lastIndexOf
in classAbstractReferenceBigList<K>
- Parameters:
k
- the object to search for.- Returns:
- the index of the last occurrence of the specified element in this big list, or -1 if this big list does not contain the element.
- See Also:
List.lastIndexOf(Object)
-
remove
public K remove(long index)
Description copied from class:AbstractReferenceBigList
Removes the element at the specified position.This implementation always throws an
UnsupportedOperationException
.
-
remove
public boolean remove(java.lang.Object k)
-
set
public K set(long index, K k)
Description copied from class:AbstractReferenceBigList
Replaces the element at the specified position in this big list with the specified element (optional operation).This implementation always throws an
UnsupportedOperationException
.
-
removeAll
public boolean removeAll(java.util.Collection<?> c)
-
clear
public void clear()
Description copied from class:AbstractReferenceBigList
This implementation delegates to
AbstractReferenceBigList.removeElements(long, long)
.- Specified by:
clear
in interfacejava.util.Collection<K>
- Overrides:
clear
in classAbstractReferenceBigList<K>
-
size64
public long size64()
Description copied from interface:Size64
Returns the size of this data structure as a long.
-
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
.
-
isEmpty
public boolean isEmpty()
Description copied from interface:Stack
Checks whether 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 ton
, this method does nothing. Otherwise, it trims the big-array length to the maximum betweenn
andsize64()
.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.
-
getElements
public void getElements(long from, java.lang.Object[][] 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 interfaceReferenceBigList<K>
- Overrides:
getElements
in classAbstractReferenceBigList<K>
- 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.
-
removeElements
public void removeElements(long from, long to)
Removes elements of this type-specific list using optimized system calls.- Specified by:
removeElements
in interfaceReferenceBigList<K>
- Overrides:
removeElements
in classAbstractReferenceBigList<K>
- Parameters:
from
- the start index (inclusive).to
- the end index (exclusive).
-
addElements
public void addElements(long index, K[][] a, long offset, long length)
Adds elements to this type-specific list using optimized system calls.- Specified by:
addElements
in interfaceReferenceBigList<K>
- Overrides:
addElements
in classAbstractReferenceBigList<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.
-
listIterator
public ObjectBigListIterator<K> listIterator(long index)
Description copied from class:AbstractReferenceBigList
Returns a type-specific list iterator on this type-specific big list starting at a given index.Note that this specification strengthens the one given in
BigList.listIterator(long)
.This implementation is based on the random-access methods.
- Specified by:
listIterator
in interfaceBigList<K>
- Specified by:
listIterator
in interfaceReferenceBigList<K>
- Overrides:
listIterator
in classAbstractReferenceBigList<K>
- 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)
-
clone
public ReferenceBigArrayBigList<K> clone()
-
equals
public boolean equals(ReferenceBigArrayBigList<K> 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.
-
-