it.unimi.dsi.fastutil.booleans

Class AbstractBooleanList

java.lang.Object

java.util.AbstractCollection<Boolean>

it.unimi.dsi.fastutil.booleans.AbstractBooleanCollection

it.unimi.dsi.fastutil.booleans.AbstractBooleanList

All Implemented Interfaces:

BooleanCollection, BooleanIterable, BooleanList, BooleanStack, Stack<Boolean>, Comparable<List<? extends Boolean>>, Iterable<Boolean>, Collection<Boolean>, List<Boolean>

Direct Known Subclasses:

AbstractBooleanList.BooleanSubList, BooleanArrayList, BooleanLists.Singleton

public abstract class AbstractBooleanList
extends AbstractBooleanCollection
implements BooleanList, BooleanStack

An abstract class providing basic methods for lists implementing a type-specific list interface.

As an additional bonus, this class implements on top of the list operations a type-specific stack.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractBooleanList.BooleanSubList A class implementing a sublist view.

Method Summary

Modifier and Type	Method and Description
boolean	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).
void	add(int index, Boolean ok) Deprecated. Please use the corresponding type-specific method instead.
boolean	addAll(BooleanCollection c) Adds all elements of the given type-specific collection to this collection.
boolean	addAll(BooleanList l) Appends all of the elements in the specified type-specific list to the end of this type-specific list (optional operation).
boolean	addAll(Collection<? extends Boolean> c) Adds all of the elements in the specified collection to this collection (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).
boolean	addAll(int index, Collection<? extends Boolean> c) Adds all of the elements in the specified collection to this list (optional operation).
void	addElements(int index, boolean[] a) Add (hopefully quickly) elements to this type-specific list.
void	addElements(int index, boolean[] a, int offset, int length) Add (hopefully quickly) elements to this type-specific list.
void	clear() Removes all of the elements from this collection (optional operation).
int	compareTo(List<? extends Boolean> l) Compares this list to another object.
boolean	contains(boolean k) Returns true if this list contains the specified element.
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
Boolean	get(int index) Deprecated. Please use the corresponding type-specific method instead.
void	getElements(int from, boolean[] a, int offset, int length) Copies (hopefully quickly) elements of this type-specific list into the given array.
int	hashCode() Returns the hash code for this list, which is identical to List.hashCode().
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.
int	indexOf(Object ok) Deprecated. Please use the corresponding type-specific method instead.
BooleanListIterator	iterator() Returns an iterator over the elements contained in this collection.
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.
int	lastIndexOf(Object ok) Deprecated. Please use the corresponding type-specific method instead.
BooleanListIterator	listIterator() Returns a type-specific list iterator on the list.
BooleanListIterator	listIterator(int index) Returns a type-specific list iterator on the list starting at a given index.
Boolean	peek(int i) Deprecated. Please use the corresponding type-specific method instead.
boolean	peekBoolean(int i) Peeks at an element on the stack (optional operation).
Boolean	pop() Deprecated. Please use the corresponding type-specific method instead.
boolean	popBoolean() Pops the top off the stack.
void	push(boolean o) Pushes the given object on the stack.
void	push(Boolean o) Deprecated. Please use the corresponding type-specific method instead.
boolean	rem(boolean k) Removes a single instance of the specified element from this collection, if it is present (optional operation).
Boolean	remove(int index) Deprecated. Please use the corresponding type-specific method instead.
boolean	removeBoolean(int i) Removes the element at the specified position in this list (optional operation).
void	removeElements(int from, int to) Removes (hopefully quickly) elements of this type-specific list.
boolean	set(int index, boolean k) Replaces the element at the specified position in this list with the specified element (optional operation).
Boolean	set(int index, Boolean ok) Deprecated. Please use the corresponding type-specific method instead.
void	size(int size) Sets the size of this list.
BooleanList	subList(int from, int to) Returns a type-specific view of the portion of this list from the index from, inclusive, to the index to, exclusive.
Boolean	top() Deprecated. Please use the corresponding type-specific method instead.
boolean	topBoolean() Peeks at the top of the stack (optional operation).
String	toString() Returns a string representation of this collection.

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

add, contains, containsAll, remove, removeAll, retainAll, toArray, toBooleanArray, toBooleanArray

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, removeAll, retainAll, size, toArray, toArray

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

add, getBoolean

Methods inherited from interface java.util.List

contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, size, sort, spliterator, toArray, toArray

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

contains, containsAll, remove, removeAll, retainAll, toArray, toBooleanArray, toBooleanArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

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

forEach, forEach

Methods inherited from interface it.unimi.dsi.fastutil.Stack

isEmpty

Method Detail

add

public void add(int index,
                boolean k)

Inserts the specified element at the specified position in this list (optional operation).

This implementation always throws an UnsupportedOperationException.

Specified by:

add in interface BooleanList

See Also:

List.add(int,Object)

add

public boolean add(boolean k)

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

This implementation always throws an UnsupportedOperationException.

This implementation delegates to the type-specific version of List.add(int, Object).

Specified by:

add in interface BooleanCollection

Specified by:

add in interface BooleanList

Overrides:

add in class AbstractBooleanCollection

See Also:

Collection.add(Object)

removeBoolean

public boolean removeBoolean(int i)

Removes the element at the specified position in this list (optional operation).

This implementation always throws an UnsupportedOperationException.

Specified by:

removeBoolean in interface BooleanList

See Also:

List.remove(int)

set

public boolean set(int index,
                   boolean k)

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

This implementation always throws an UnsupportedOperationException.

Specified by:

set in interface BooleanList

See Also:

List.set(int,Object)

addAll

public boolean addAll(int index,
                      Collection<? extends Boolean> c)

Adds all of the elements in the specified collection to this list (optional operation).

Specified by:

addAll in interface List<Boolean>

Parameters:

index - index at which to insert the first element from the specified collection

c - collection containing elements to be added to this list

Returns:

true if this list changed as a result of the call

addAll

public boolean addAll(Collection<? extends Boolean> c)

Adds all of the elements in the specified collection to this collection (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified collection is this collection, and this collection is nonempty.)

This implementation iterates over the specified collection, and adds each object returned by the iterator to this collection, in turn.

Note that this implementation will throw an UnsupportedOperationException unless add is overridden (assuming the specified collection is non-empty).

This implementation delegates to the type-specific version of List.addAll(int, Collection).

Specified by:

addAll in interface Collection<Boolean>

Specified by:

addAll in interface List<Boolean>

Overrides:

addAll in class AbstractCollection<Boolean>

Parameters:

c - collection containing elements to be added to this collection

Returns:

true if this collection changed as a result of the call

See Also:

AbstractCollection.add(Object)

iterator

public BooleanListIterator iterator()

Returns an iterator over the elements contained in this collection.

This implementation delegates to listIterator().

Specified by:

iterator in interface BooleanCollection

Specified by:

iterator in interface BooleanIterable

Specified by:

iterator in interface BooleanList

Specified by:

iterator in interface Iterable<Boolean>

Specified by:

iterator in interface Collection<Boolean>

Specified by:

iterator in interface List<Boolean>

Specified by:

iterator in class AbstractBooleanCollection

Returns:

an iterator over the elements contained in this collection

See Also:

Iterable.iterator()

listIterator

public BooleanListIterator listIterator()

Returns a type-specific list iterator on the list.

This implementation delegates to listIterator(0).

Specified by:

listIterator in interface BooleanList

Specified by:

listIterator in interface List<Boolean>

Returns:

a list iterator over the elements in this list (in proper sequence)

See Also:

List.listIterator()

listIterator

public BooleanListIterator listIterator(int index)

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

This implementation is based on the random-access methods.

Specified by:

listIterator in interface BooleanList

Specified by:

listIterator in interface List<Boolean>

Parameters:

index - index of the first element to be returned from the list iterator (by a call to next)

Returns:

a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list

See Also:

List.listIterator(int)

contains

public boolean contains(boolean k)

Returns true if this list contains the specified element.

This implementation delegates to indexOf().

Specified by:

contains in interface BooleanCollection

Overrides:

contains in class AbstractBooleanCollection

See Also:

List.contains(Object)

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

See Also:

List.indexOf(Object)

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

See Also:

List.lastIndexOf(Object)

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

Parameters:

size - the new size.

subList

public BooleanList subList(int from,
                           int to)

Description copied from interface: BooleanList

Returns a type-specific view of the portion of this list from the index from, inclusive, to the index to, exclusive.

Note that this specification strengthens the one given in List.subList(int,int).

Specified by:

subList in interface BooleanList

Specified by:

subList in interface List<Boolean>

Parameters:

from - low endpoint (inclusive) of the subList

to - high endpoint (exclusive) of the subList

Returns:

a view of the specified range within this list

See Also:

List.subList(int,int)

removeElements

public void removeElements(int from,
                           int to)

Removes (hopefully quickly) elements of this type-specific list.

This is a trivial iterator-based implementation. It is expected that implementations will override this method with a more optimized version.

Specified by:

removeElements in interface BooleanList

Parameters:

from - the start index (inclusive).

to - the end index (exclusive).

addElements

public void addElements(int index,
                        boolean[] a,
                        int offset,
                        int length)

Add (hopefully quickly) elements to this type-specific list.

This is a trivial iterator-based implementation. It is expected that implementations will override this method with a more optimized version.

Specified by:

addElements in interface BooleanList

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.

addElements

public void addElements(int index,
                        boolean[] a)

Add (hopefully quickly) elements to this type-specific list.

This implementation delegates to the analogous method for array fragments.

Specified by:

addElements in interface BooleanList

Parameters:

index - the index at which to add elements.

a - the array containing the elements.

getElements

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

Copies (hopefully quickly) elements of this type-specific list into the given array.

This is a trivial iterator-based implementation. It is expected that implementations will override this method with a more optimized version.

Specified by:

getElements in interface BooleanList

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.

clear

public void clear()

Removes all of the elements from this collection (optional operation). The collection will be empty after this method returns.

This implementation iterates over this collection, removing each element using the Iterator.remove operation. Most implementations will probably choose to override this method for efficiency.

Note that this implementation will throw an UnsupportedOperationException if the iterator returned by this collection's iterator method does not implement the remove method and this collection is non-empty.

This implementation delegates to removeElements(int, int).

Specified by:

clear in interface Collection<Boolean>

Specified by:

clear in interface List<Boolean>

Overrides:

clear in class AbstractCollection<Boolean>

hashCode

public int hashCode()

Returns the hash code for this list, which is identical to List.hashCode().

Specified by:

hashCode in interface Collection<Boolean>

Specified by:

hashCode in interface List<Boolean>

Overrides:

hashCode in class Object

Returns:

the hash code for this list.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

equals

public boolean equals(Object o)

Description copied from class: java.lang.Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Specified by:

equals in interface Collection<Boolean>

Specified by:

equals in interface List<Boolean>

Overrides:

equals in class Object

Parameters:

o - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Object.hashCode(), HashMap

compareTo

public int compareTo(List<? extends Boolean> l)

Compares this list to another object. If the argument is a List, this method performs a lexicographical comparison; otherwise, it throws a ClassCastException.

Specified by:

compareTo in interface Comparable<List<? extends Boolean>>

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.

Throws:

ClassCastException - if the argument is not a list.

push

public void push(boolean o)

Description copied from interface: BooleanStack

Pushes the given object on the stack.

Specified by:

push in interface BooleanStack

Parameters:

o - the object to push on the stack.

See Also:

Stack.push(Object)

popBoolean

public boolean popBoolean()

Description copied from interface: BooleanStack

Pops the top off the stack.

Specified by:

popBoolean in interface BooleanStack

Returns:

the top of the stack.

See Also:

Stack.pop()

topBoolean

public boolean topBoolean()

Description copied from interface: BooleanStack

Peeks at the top of the stack (optional operation).

Specified by:

topBoolean in interface BooleanStack

Returns:

the top of the stack.

See Also:

Stack.top()

peekBoolean

public boolean peekBoolean(int i)

Description copied from interface: BooleanStack

Peeks at an element on the stack (optional operation).

Specified by:

peekBoolean in interface BooleanStack

Parameters:

i - an index from the stop of the stack (0 represents the top).

Returns:

the i-th element on the stack.

See Also:

Stack.peek(int)

rem

public boolean rem(boolean k)

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

This implementation delegates to indexOf().

Specified by:

rem in interface BooleanCollection

Overrides:

rem in class AbstractBooleanCollection

See Also:

List.remove(Object)

addAll

public boolean addAll(int index,
                      BooleanCollection c)

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

See Also:

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

addAll

public 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).

This implementation delegates to the type-specific version of List.addAll(int, Collection).

Specified by:

addAll in interface BooleanList

See Also:

List.add(int,Object)

addAll

public boolean addAll(BooleanCollection c)

Adds all elements of the given type-specific collection to this collection.

This implementation delegates to the type-specific version of List.addAll(int, Collection).

Specified by:

addAll in interface BooleanCollection

Overrides:

addAll in class AbstractBooleanCollection

Parameters:

c - a type-specific collection.

Returns:

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

See Also:

Collection.addAll(Collection)

addAll

public boolean addAll(BooleanList l)

Appends all of the elements in the specified type-specific list to the end of this type-specific list (optional operation).

This implementation delegates to the type-specific list version of List.addAll(int, Collection).

Specified by:

addAll in interface BooleanList

See Also:

List.add(int,Object)

add

@Deprecated
public void add(int index,
                            Boolean ok)

Deprecated. Please use the corresponding type-specific method instead.

Inserts the specified element at the specified position in this list (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).

This implementation delegates to the corresponding type-specific method.

Specified by:

add in interface BooleanList

Specified by:

add in interface List<Boolean>

Parameters:

index - index at which the specified element is to be inserted

ok - element to be inserted

set

@Deprecated
public Boolean set(int index,
                               Boolean ok)

Deprecated. Please use the corresponding type-specific method instead.

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

This implementation delegates to the corresponding type-specific method.

Specified by:

set in interface BooleanList

Specified by:

set in interface List<Boolean>

Parameters:

index - index of the element to replace

ok - element to be stored at the specified position

Returns:

the element previously at the specified position

get

@Deprecated
public Boolean get(int index)

Deprecated. Please use the corresponding type-specific method instead.

Returns the element at the specified position in this list.

This implementation delegates to the corresponding type-specific method.

Specified by:

get in interface BooleanList

Specified by:

get in interface List<Boolean>

Parameters:

index - index of the element to return

Returns:

the element at the specified position in this list

indexOf

@Deprecated
public int indexOf(Object ok)

Deprecated. Please use the corresponding type-specific method instead.

Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.

This implementation delegates to the corresponding type-specific method.

Specified by:

indexOf in interface BooleanList

Specified by:

indexOf in interface List<Boolean>

Parameters:

ok - element to search for

Returns:

the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element

lastIndexOf

@Deprecated
public int lastIndexOf(Object ok)

Deprecated. Please use the corresponding type-specific method instead.

Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the highest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.

This implementation delegates to the corresponding type-specific method.

Specified by:

lastIndexOf in interface BooleanList

Specified by:

lastIndexOf in interface List<Boolean>

Parameters:

ok - element to search for

Returns:

the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element

remove

@Deprecated
public Boolean remove(int index)

Deprecated. Please use the corresponding type-specific method instead.

Removes the element at the specified position in this list (optional operation). Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the list.

This implementation delegates to the corresponding type-specific method.

Specified by:

remove in interface BooleanList

Specified by:

remove in interface List<Boolean>

Parameters:

index - the index of the element to be removed

Returns:

the element previously at the specified position

push

@Deprecated
public void push(Boolean o)

Deprecated. Please use the corresponding type-specific method instead.

Pushes the given object on the stack.

This default implementation delegates to the corresponding type-specific method.

This implementation delegates to the corresponding type-specific method.

Specified by:

push in interface BooleanStack

Specified by:

push in interface Stack<Boolean>

Parameters:

o - the object that will become the new top of the stack.

pop

@Deprecated
public Boolean pop()

Deprecated. Please use the corresponding type-specific method instead.

Pops the top off the stack.

This default implementation delegates to the corresponding type-specific method.

This implementation delegates to the corresponding type-specific method.

Specified by:

pop in interface BooleanStack

Specified by:

pop in interface Stack<Boolean>

Returns:

the top of the stack.

top

@Deprecated
public Boolean top()

Deprecated. Please use the corresponding type-specific method instead.

Peeks at the top of the stack (optional operation).

This default implementation returns peek(0).

This default implementation delegates to the corresponding type-specific method.

This implementation delegates to the corresponding type-specific method.

Specified by:

top in interface BooleanStack

Specified by:

top in interface Stack<Boolean>

Returns:

the top of the stack.

peek

@Deprecated
public Boolean peek(int i)

Deprecated. Please use the corresponding type-specific method instead.

Peeks at an element on the stack (optional operation).

This default implementation just throws an UnsupportedOperationException.

This default implementation delegates to the corresponding type-specific method.

This implementation delegates to the corresponding type-specific method.

Specified by:

peek in interface BooleanStack

Specified by:

peek in interface Stack<Boolean>

Parameters:

i - an index from the stop of the stack (0 represents the top).

Returns:

the i-th element on the stack.

toString

public String toString()

Description copied from class: java.util.AbstractCollection

Returns a string representation of this collection. The string representation consists of a list of the collection's elements in the order they are returned by its iterator, enclosed in square brackets ("[]"). Adjacent elements are separated by the characters ", " (comma and space). Elements are converted to strings as by String.valueOf(Object).

Overrides:

toString in class AbstractBooleanCollection

Returns:

a string representation of this collection