it.unimi.dsi.fastutil.booleans

Class BooleanArrayList

java.lang.Object

java.util.AbstractCollection<java.lang.Boolean>

it.unimi.dsi.fastutil.booleans.AbstractBooleanCollection

it.unimi.dsi.fastutil.booleans.AbstractBooleanList

it.unimi.dsi.fastutil.booleans.BooleanArrayList

All Implemented Interfaces:

BooleanCollection, BooleanIterable, BooleanList, BooleanStack, Stack<java.lang.Boolean>, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<java.util.List<? extends java.lang.Boolean>>, java.lang.Iterable<java.lang.Boolean>, java.util.Collection<java.lang.Boolean>, java.util.List<java.lang.Boolean>, java.util.RandomAccess

public class BooleanArrayList
extends AbstractBooleanList
implements java.util.RandomAccess, java.lang.Cloneable, java.io.Serializable

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

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 doubling its current length), 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:

ArrayList, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.booleans.AbstractBooleanList

AbstractBooleanList.BooleanSubList

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean[]	a The backing array.
static int	DEFAULT_INITIAL_CAPACITY The initial default capacity of an array list.
protected int	size The current actual size of the list (never greater than the backing-array length).

Constructor Summary

Constructors

Modifier	Constructor and Description
	BooleanArrayList() Creates a new array list with DEFAULT_INITIAL_CAPACITY capacity.
	BooleanArrayList(boolean[] a) Creates a new array list and fills it with the elements of a given array.
protected	BooleanArrayList(boolean[] a, boolean dummy) Creates a new array list using 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(BooleanCollection c) Creates a new array list and fills it with a given type-specific collection.
	BooleanArrayList(BooleanIterator i) Creates a new array list and fills it with the elements returned by a type-specific iterator..
	BooleanArrayList(BooleanList l) Creates a new array list and fills it with a given type-specific list.
	BooleanArrayList(java.util.Collection<? extends java.lang.Boolean> c) Creates a new array list and fills it with a given collection.
	BooleanArrayList(int capacity) Creates a new array list with given capacity.
	BooleanArrayList(java.util.Iterator<? extends java.lang.Boolean> i) Creates a new array list and fills it with the elements returned by an iterator..

Method Summary

Modifier and Type	Method and Description
boolean	add(boolean k)
void	add(int index, boolean k)
boolean	addAll(int index, BooleanCollection c) Delegates to a more generic method.
boolean	addAll(int index, BooleanList l) Delegates to a more generic method.
void	addElements(int index, boolean[] a, int offset, int length) Adds elements to this type-specific list using optimized system calls.
void	clear()
BooleanArrayList	clone()
int	compareTo(BooleanArrayList l) Compares this array list to another array list.
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	equals(BooleanArrayList l) Compares this type-specific array list to another one.
boolean	getBoolean(int index)
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)
boolean	isEmpty() Checks whether the stack is empty.
int	lastIndexOf(boolean k)
BooleanListIterator	listIterator(int index) Returns a type-specific list iterator on the list starting at a given index.
boolean	rem(boolean k) Note that this method should be called remove(), but the clash with the similarly named index-based method in the List interface forces us to use a distinguished name.
boolean	removeAll(BooleanCollection c) Remove from this collection all elements in the given type-specific collection.
boolean	removeAll(java.util.Collection<?> c) Remove from this collection all elements in the given collection.
boolean	removeBoolean(int index)
void	removeElements(int from, int to) Removes elements of this type-specific list using optimized system calls.
boolean	set(int index, boolean k)
int	size()
void	size(int size) Sets the size of this list.
boolean[]	toBooleanArray(boolean[] a) Returns a primitive type array containing the items of this collection.
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.
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

add, addAll, addAll, addAll, addAll, addElements, booleanListIterator, booleanListIterator, booleanSubList, compareTo, contains, ensureIndex, ensureRestrictedIndex, equals, get, hashCode, indexOf, iterator, lastIndexOf, listIterator, peek, peekBoolean, pop, popBoolean, push, push, remove, remove, set, subList, top, topBoolean, toString

Methods inherited from class it.unimi.dsi.fastutil.booleans.AbstractBooleanCollection

add, booleanIterator, contains, containsAll, containsAll, rem, retainAll, retainAll, toArray, toArray, toArray, toBooleanArray

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

add, contains, containsAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Methods inherited from interface it.unimi.dsi.fastutil.booleans.BooleanCollection

booleanIterator, containsAll, retainAll, toArray, toArray, toBooleanArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

DEFAULT_INITIAL_CAPACITY

public static final int DEFAULT_INITIAL_CAPACITY

The initial default capacity of an array list.

See Also:

Constant Field Values

a

protected transient boolean[] a

The backing array.

size

protected int size

The current actual size of the list (never greater than the backing-array length).

Constructor Detail

BooleanArrayList

protected BooleanArrayList(boolean[] a,
                           boolean dummy)

Creates a new array list using a given array.

This constructor is only meant to be used by the wrapping methods.

Parameters:

a - the array that will be used to back this array list.

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 with DEFAULT_INITIAL_CAPACITY capacity.

BooleanArrayList

public BooleanArrayList(java.util.Collection<? extends java.lang.Boolean> c)

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

public BooleanArrayList(BooleanCollection c)

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

public BooleanArrayList(BooleanList l)

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

public BooleanArrayList(java.util.Iterator<? extends java.lang.Boolean> i)

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

public BooleanArrayList(BooleanIterator i)

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 Detail

elements

public boolean[] elements()

Returns the backing array of this list.

Returns:

the backing array.

wrap

public static BooleanArrayList wrap(boolean[] a,
                                    int length)

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

public static BooleanArrayList wrap(boolean[] a)

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.

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)

Specified by:

add in interface BooleanList

Overrides:

add in class AbstractBooleanList

See Also:

List.add(int,Object)

add

public boolean add(boolean k)

Specified by:

add in interface BooleanCollection

Specified by:

add in interface BooleanList

Overrides:

add in class AbstractBooleanList

See Also:

Collection.add(Object)

getBoolean

public boolean getBoolean(int index)

Specified by:

getBoolean in interface BooleanList

See Also:

List.get(int)

indexOf

public int indexOf(boolean k)

Specified by:

indexOf in interface BooleanList

Overrides:

indexOf in class AbstractBooleanList

See Also:

List.indexOf(Object)

lastIndexOf

public int lastIndexOf(boolean k)

Specified by:

lastIndexOf in interface BooleanList

Overrides:

lastIndexOf in class AbstractBooleanList

See Also:

List.lastIndexOf(Object)

removeBoolean

public boolean removeBoolean(int index)

Specified by:

removeBoolean in interface BooleanList

Overrides:

removeBoolean in class AbstractBooleanList

See Also:

List.remove(int)

rem

public boolean rem(boolean k)

Description copied from interface: BooleanCollection

Note that this method should be called remove(), but the clash with the similarly named index-based method in the List interface forces us to use a distinguished name. For simplicity, the set interfaces reinstates remove().

Specified by:

rem in interface BooleanCollection

Overrides:

rem in class AbstractBooleanList

See Also:

Collection.remove(Object)

set

public boolean set(int index,
                   boolean k)

Specified by:

set in interface BooleanList

Overrides:

set in class AbstractBooleanList

See Also:

List.set(int,Object)

clear

public void clear()

Specified by:

clear in interface java.util.Collection<java.lang.Boolean>

Specified by:

clear in interface java.util.List<java.lang.Boolean>

Overrides:

clear in class java.util.AbstractCollection<java.lang.Boolean>

size

public int size()

Specified by:

size in interface java.util.Collection<java.lang.Boolean>

Specified by:

size in interface java.util.List<java.lang.Boolean>

Specified by:

size in class java.util.AbstractCollection<java.lang.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 interface BooleanList

Overrides:

size in class AbstractBooleanList

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 Stack<java.lang.Boolean>

Specified by:

isEmpty in interface java.util.Collection<java.lang.Boolean>

Specified by:

isEmpty in interface java.util.List<java.lang.Boolean>

Overrides:

isEmpty in class AbstractBooleanCollection

Returns:

true if the stack is empty.

trim

public void trim()

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

See Also:

ArrayList.trimToSize()

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 to n, this method does nothing. Otherwise, it trims the array length to the maximum between n and size().

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.

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 interface BooleanList

Overrides:

getElements in class AbstractBooleanList

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 interface BooleanList

Overrides:

removeElements in class AbstractBooleanList

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 interface BooleanList

Overrides:

addElements in class AbstractBooleanList

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.

toBooleanArray

public boolean[] toBooleanArray(boolean[] a)

Description copied from interface: BooleanCollection

Returns a primitive type array containing the items of this collection.

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:

toBooleanArray in interface BooleanCollection

Overrides:

toBooleanArray in class AbstractBooleanCollection

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:

Collection.toArray(Object[])

addAll

public boolean addAll(int index,
                      BooleanCollection c)

Description copied from class: AbstractBooleanList

Delegates to a more generic method.

Specified by:

addAll in interface BooleanList

Overrides:

addAll in class AbstractBooleanList

See Also:

List.add(int,Object)

addAll

public boolean addAll(int index,
                      BooleanList l)

Description copied from class: AbstractBooleanList

Delegates to a more generic method.

Specified by:

addAll in interface BooleanList

Overrides:

addAll in class AbstractBooleanList

See Also:

List.add(int,Object)

removeAll

public boolean removeAll(BooleanCollection c)

Description copied from class: AbstractBooleanCollection

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

Specified by:

removeAll in interface BooleanCollection

Overrides:

removeAll in class AbstractBooleanCollection

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(java.util.Collection<?> c)

Description copied from class: AbstractBooleanCollection

Remove from this collection all elements in the given collection. If the collection is an instance of this class, it uses faster iterators.

Specified by:

removeAll in interface java.util.Collection<java.lang.Boolean>

Specified by:

removeAll in interface java.util.List<java.lang.Boolean>

Overrides:

removeAll in class AbstractBooleanCollection

Parameters:

c - a collection.

Returns:

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

listIterator

public BooleanListIterator listIterator(int index)

Description copied from interface: BooleanList

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

Specified by:

listIterator in interface BooleanList

Specified by:

listIterator in interface java.util.List<java.lang.Boolean>

Overrides:

listIterator in class AbstractBooleanList

See Also:

List.listIterator(int)

clone

public BooleanArrayList clone()

Overrides:

clone in class java.lang.Object

equals

public boolean equals(BooleanArrayList l)

Compares this type-specific 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 array list.

Returns:

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

compareTo

public int compareTo(BooleanArrayList l)

Compares this array list to another array list.

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

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.