Class BooleanArrayList
- All Implemented Interfaces:
BooleanCollection
,BooleanIterable
,BooleanList
,BooleanStack
,Stack<Boolean>
,Serializable
,Cloneable
,Comparable<List<? extends Boolean>>
,Iterable<Boolean>
,Collection<Boolean>
,List<Boolean>
,RandomAccess
,SequencedCollection<Boolean>
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 classes/interfaces inherited from class it.unimi.dsi.fastutil.booleans.AbstractBooleanList
AbstractBooleanList.BooleanRandomAccessSubList, AbstractBooleanList.BooleanSubList
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The initial default capacity of an array list. -
Constructor Summary
ConstructorDescriptionCreates a new array list withDEFAULT_INITIAL_CAPACITY
capacity.BooleanArrayList
(boolean[] a) Creates a new array list and fills it with the elements of a given array.BooleanArrayList
(boolean[] a, int offset, int length) Creates a new array list and fills it with the elements of a given array.BooleanArrayList
(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.BooleanArrayList
(Collection<? extends Boolean> c) Creates a new array list and fills it with a given collection.BooleanArrayList
(Iterator<? extends Boolean> i) Creates a new array list and fills it with the elements returned by an iterator.. -
Method Summary
Modifier and TypeMethodDescriptionboolean
add
(boolean k) Ensures that this collection contains the specified element (optional operation).void
add
(int index, boolean k) Inserts the specified element at the specified position in this list (optional operation).boolean
addAll
(int index, BooleanCollection c) Inserts all of the elements in the specified type-specific collection into this type-specific list at the specified position (optional operation).boolean
addAll
(int index, BooleanList l) Inserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).void
addElements
(int index, boolean[] a, int offset, int length) Adds elements to this type-specific list using optimized system calls.void
clear()
clone()
int
Compares this array list to another array list.int
Compares this list to another object.boolean[]
elements()
Returns the backing array of this list.void
ensureCapacity
(int capacity) Ensures that this array list can contain the given number of entries without resizing.boolean
Compares this type-specific array list to another one.boolean
void
forEach
(BooleanConsumer action) Performs the given action for each element of this type-specificIterable
until all elements have been processed or the action throws an exception.boolean
getBoolean
(int index) Returns the element at the specified position in this list.void
getElements
(int from, boolean[] a, int offset, int length) Copies element of this type-specific list into the given array using optimized system calls.int
indexOf
(boolean 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
(boolean 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 BooleanArrayList
of()
Creates a new empty array list.static BooleanArrayList
of
(boolean... init) Creates an array list using an array of elements.boolean
rem
(boolean k) Removes a single instance of the specified element from this collection, if it is present (optional operation).boolean
Remove from this collection all elements in the given type-specific collection.boolean
removeBoolean
(int index) Removes the element at the specified position in this list (optional operation).void
removeElements
(int from, int to) Removes elements of this type-specific list using optimized system calls.boolean
removeIf
(BooleanPredicate filter) Remove from this collection all elements which satisfy the given predicate.boolean
set
(int index, boolean k) Replaces the element at the specified position in this list with the specified element (optional operation).void
setElements
(int index, boolean[] a, int offset, int length) Sets elements to this type-specific list using optimized system calls.int
size()
void
size
(int size) Sets the size of this list.void
sort
(BooleanComparator comp) Sort a list using a type-specific comparator.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.boolean[]
toArray
(boolean[] 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.void
trim()
Trims this array list so that the capacity is equal to the size.void
trim
(int n) Trims the backing array if it is too large.void
Sorts this list using a sort not assured to be stable.static BooleanArrayList
wrap
(boolean[] a) Wraps a given array into an array list.static BooleanArrayList
wrap
(boolean[] a, int length) Wraps a given array into an array list of given size.Methods inherited from class it.unimi.dsi.fastutil.booleans.AbstractBooleanList
addAll, addAll, addAll, addElements, contains, hashCode, iterator, listIterator, peekBoolean, popBoolean, push, toBooleanArray, topBoolean, toString
Methods inherited from class it.unimi.dsi.fastutil.booleans.AbstractBooleanCollection
add, contains, containsAll, containsAll, remove, removeAll, retainAll, retainAll, toBooleanArray
Methods inherited from class java.util.AbstractCollection
toArray, toArray
Methods inherited from interface it.unimi.dsi.fastutil.booleans.BooleanCollection
containsAll, removeIf, retainAll, toBooleanArray
Methods inherited from interface it.unimi.dsi.fastutil.booleans.BooleanIterable
forEach
Methods inherited from interface it.unimi.dsi.fastutil.booleans.BooleanList
add, add, addAll, contains, get, indexOf, lastIndexOf, remove, remove, replaceAll, replaceAll, set, setElements, setElements, sort, unstableSort
Methods inherited from interface it.unimi.dsi.fastutil.booleans.BooleanStack
peek, pop, push, top
Methods inherited from interface java.util.Collection
parallelStream, stream, toArray
Methods 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
-
BooleanArrayList
public BooleanArrayList(int capacity) Creates a new array list with given capacity.- Parameters:
capacity
- the initial capacity of the array list (may be 0).
-
BooleanArrayList
public BooleanArrayList()Creates a new array list withDEFAULT_INITIAL_CAPACITY
capacity. -
BooleanArrayList
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.
-
BooleanArrayList
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.
-
BooleanArrayList
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.
-
BooleanArrayList
public BooleanArrayList(boolean[] 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.
-
BooleanArrayList
public BooleanArrayList(boolean[] 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.
-
BooleanArrayList
Creates a new array list and fills it with the elements returned by an iterator..- Parameters:
i
- an iterator whose returned elements will fill the array list.
-
BooleanArrayList
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 boolean[] 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
Creates a new empty array list.- Returns:
- a new empty array list.
-
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:
-
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, boolean k) Description copied from class:AbstractBooleanList
Inserts the specified element at the specified position in this list (optional operation).- Specified by:
add
in interfaceBooleanList
- Overrides:
add
in classAbstractBooleanList
- See Also:
-
add
public boolean add(boolean k) Description copied from class:AbstractBooleanList
Ensures that this collection contains the specified element (optional operation).- Specified by:
add
in interfaceBooleanCollection
- Specified by:
add
in interfaceBooleanList
- Overrides:
add
in classAbstractBooleanList
- See Also:
-
getBoolean
public boolean getBoolean(int index) Description copied from interface:BooleanList
Returns the element at the specified position in this list.- Specified by:
getBoolean
in interfaceBooleanList
- See Also:
-
indexOf
public int indexOf(boolean k) Description copied from interface:BooleanList
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 interfaceBooleanList
- Overrides:
indexOf
in classAbstractBooleanList
- See Also:
-
lastIndexOf
public int lastIndexOf(boolean k) Description copied from interface:BooleanList
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 interfaceBooleanList
- Overrides:
lastIndexOf
in classAbstractBooleanList
- See Also:
-
removeBoolean
public boolean removeBoolean(int index) Description copied from class:AbstractBooleanList
Removes the element at the specified position in this list (optional operation).- Specified by:
removeBoolean
in interfaceBooleanList
- Overrides:
removeBoolean
in classAbstractBooleanList
- See Also:
-
rem
public boolean rem(boolean k) Description copied from class:AbstractBooleanList
Removes a single instance of the specified element from this collection, if it is present (optional operation).- Specified by:
rem
in interfaceBooleanCollection
- Overrides:
rem
in classAbstractBooleanList
- See Also:
-
set
public boolean set(int index, boolean k) Description copied from class:AbstractBooleanList
Replaces the element at the specified position in this list with the specified element (optional operation).- Specified by:
set
in interfaceBooleanList
- Overrides:
set
in classAbstractBooleanList
- See Also:
-
clear
public void clear()Description copied from class:AbstractBooleanList
- Specified by:
clear
in interfaceCollection<Boolean>
- Specified by:
clear
in interfaceList<Boolean>
- Overrides:
clear
in classAbstractBooleanList
-
size
public int size()- Specified by:
size
in interfaceCollection<Boolean>
- Specified by:
size
in interfaceList<Boolean>
- Specified by:
size
in classAbstractCollection<Boolean>
-
size
public void size(int size) Description copied from interface:BooleanList
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 interfaceBooleanList
- Overrides:
size
in classAbstractBooleanList
- Parameters:
size
- the new size.
-
isEmpty
public boolean isEmpty()Description copied from interface:Stack
Checks 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 betweenn
andsize()
.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:BooleanList
Returns a type-specific view of the portion of this list from the indexfrom
, inclusive, to the indexto
, exclusive.- Specified by:
subList
in interfaceBooleanList
- Specified by:
subList
in interfaceList<Boolean>
- Overrides:
subList
in classAbstractBooleanList
- See Also:
-
getElements
public void getElements(int from, boolean[] a, int offset, int length) Copies element of this type-specific list into the given array using optimized system calls.- Specified by:
getElements
in interfaceBooleanList
- Overrides:
getElements
in classAbstractBooleanList
- 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:
removeElements
in interfaceBooleanList
- Overrides:
removeElements
in classAbstractBooleanList
- Parameters:
from
- the start index (inclusive).to
- the end index (exclusive).
-
addElements
public void addElements(int index, boolean[] a, int offset, int length) Adds elements to this type-specific list using optimized system calls.- Specified by:
addElements
in interfaceBooleanList
- Overrides:
addElements
in classAbstractBooleanList
- 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, boolean[] a, int offset, int length) Sets elements to this type-specific list using optimized system calls.- Specified by:
setElements
in interfaceBooleanList
- Overrides:
setElements
in classAbstractBooleanList
- 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:AbstractBooleanList
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 interfaceBooleanIterable
- Overrides:
forEach
in classAbstractBooleanList
- Parameters:
action
- the action to be performed for each element.- See Also:
-
addAll
Description copied from interface:BooleanList
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 interfaceBooleanList
- Overrides:
addAll
in classAbstractBooleanList
- See Also:
-
addAll
Description copied from interface:BooleanList
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 interfaceBooleanList
- See Also:
-
removeAll
Description copied from interface:BooleanCollection
Remove from this collection all elements in the given type-specific collection.- Specified by:
removeAll
in interfaceBooleanCollection
- Overrides:
removeAll
in classAbstractBooleanCollection
- Parameters:
c
- a type-specific collection.- Returns:
true
if this collection changed as a result of the call.- See Also:
-
removeIf
Description copied from interface:BooleanCollection
Remove from this collection all elements which satisfy the given predicate.- Specified by:
removeIf
in interfaceBooleanCollection
- Parameters:
filter
- a predicate which returnstrue
for elements to be removed.- Returns:
true
if any elements were removed.- See Also:
-
toArray
public boolean[] toArray(boolean[] a) Description copied from interface:BooleanCollection
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 interfaceBooleanCollection
- Overrides:
toArray
in classAbstractBooleanList
- 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:AbstractBooleanList
Returns a type-specific list iterator on the list starting at a given index.- Specified by:
listIterator
in interfaceBooleanList
- Specified by:
listIterator
in interfaceList<Boolean>
- Overrides:
listIterator
in classAbstractBooleanList
- See Also:
-
spliterator
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.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:
spliterator
in interfaceBooleanCollection
- Specified by:
spliterator
in interfaceBooleanIterable
- Specified by:
spliterator
in interfaceBooleanList
- Specified by:
spliterator
in interfaceCollection<Boolean>
- Specified by:
spliterator
in interfaceIterable<Boolean>
- Specified by:
spliterator
in interfaceList<Boolean>
- Returns:
- a type-specific spliterator on the elements of this collection.
-
sort
Description copied from interface:BooleanList
Sort a list using a type-specific comparator.Pass
null
to sort using natural ordering.- Specified by:
sort
in interfaceBooleanList
- See Also:
-
unstableSort
Description copied from interface:BooleanList
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 interfaceBooleanList
-
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:
equals
in interfaceCollection<Boolean>
- Specified by:
equals
in interfaceList<Boolean>
- Overrides:
equals
in classAbstractBooleanList
-
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:AbstractBooleanList
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 Boolean>>
- Overrides:
compareTo
in classAbstractBooleanList
- 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.
-