it.unimi.dsi.fastutil.booleans

Class AbstractBooleanBigList

java.lang.Object

java.util.AbstractCollection<Boolean>

it.unimi.dsi.fastutil.booleans.AbstractBooleanCollection

it.unimi.dsi.fastutil.booleans.AbstractBooleanBigList

All Implemented Interfaces:

BigList<Boolean>, BooleanBigList, BooleanCollection, BooleanIterable, BooleanStack, Size64, Stack<Boolean>, Comparable<BigList<? extends Boolean>>, Iterable<Boolean>, Collection<Boolean>

Direct Known Subclasses:

AbstractBooleanBigList.BooleanSubList, BooleanBigArrayBigList, BooleanBigLists.ListBigList, BooleanBigLists.Singleton

public abstract class AbstractBooleanBigList
extends AbstractBooleanCollection
implements BooleanBigList, BooleanStack

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBooleanBigList()

Method Summary

Modifier and Type	Method and Description
boolean	add(boolean k) Ensures that this collection contains the specified element (optional operation).
void	add(long index, boolean k) Inserts the specified element at the specified position in this type-specific big list (optional operation).
void	add(long index, Boolean ok) Deprecated. Please use the corresponding type-specific method instead.
boolean	addAll(BooleanBigList l) Appends all of the elements in the specified type-specific big list to the end of this type-specific big list (optional operation).
boolean	addAll(BooleanCollection c) Adds all elements of the given type-specific collection to this collection.
boolean	addAll(Collection<? extends Boolean> c)
boolean	addAll(long index, BooleanBigList l) 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, BooleanCollection 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, Collection<? extends Boolean> c) Adds all of the elements in the specified collection to this list (optional operation).
void	addElements(long index, boolean[][] a) Add (hopefully quickly) elements to this type-specific big list.
void	addElements(long index, boolean[][] a, long offset, long length) Add (hopefully quickly) elements to this type-specific big list.
void	clear()
int	compareTo(BigList<? extends Boolean> l) Compares this big list to another object.
boolean	contains(boolean k) Returns true if this list contains the specified element.
protected void	ensureIndex(long index) Ensures that the given index is nonnegative and not greater than this big-list size.
protected void	ensureRestrictedIndex(long index) Ensures that the given index is nonnegative and smaller than this big-list size.
boolean	equals(Object o)
Boolean	get(long index) Deprecated. Please use the corresponding type-specific method instead.
void	getElements(long from, boolean[][] a, long offset, long length) Copies (hopefully quickly) elements of this type-specific big list into the given big array.
int	hashCode() Returns the hash code for this big list, which is identical to List.hashCode().
long	indexOf(boolean 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.
long	indexOf(Object ok) Deprecated. Please use the corresponding type-specific method instead.
BooleanBigListIterator	iterator() Returns a type-specific iterator on the elements of this collection.
long	lastIndexOf(boolean 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.
long	lastIndexOf(Object ok) Deprecated. Please use the corresponding type-specific method instead.
BooleanBigListIterator	listIterator() Returns a type-specific big-list iterator on this type-specific big list.
BooleanBigListIterator	listIterator(long index) Returns a type-specific list iterator on this type-specific big 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(long index) Deprecated. Please use the corresponding type-specific method instead.
boolean	removeBoolean(long i) Removes the element at the specified position.
void	removeElements(long from, long to) Removes (hopefully quickly) elements of this type-specific big list.
boolean	set(long index, boolean k) Replaces the element at the specified position in this big list with the specified element (optional operation).
Boolean	set(long index, Boolean ok) Deprecated. Please use the corresponding type-specific method instead.
int	size() Deprecated. Please use Size64.size64() instead.
void	size(long size) Sets the size of this big list.
BooleanBigList	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.
Boolean	top() Deprecated. Please use the corresponding type-specific method instead.
boolean	topBoolean() Peeks at the top of the stack (optional operation).
String	toString()

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, toArray, toArray

Methods inherited from class java.lang.Object

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

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

getBoolean

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

size64

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

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

Methods inherited from interface java.util.Collection

containsAll, isEmpty, parallelStream, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray

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

forEach, forEach

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

isEmpty

Constructor Detail

AbstractBooleanBigList

protected AbstractBooleanBigList()

Method Detail

ensureIndex

protected void ensureIndex(long index)

Ensures that the given index is nonnegative and not greater than this big-list size.

Parameters:

index - an index.

Throws:

IndexOutOfBoundsException - if the given index is negative or greater than this big-list size.

ensureRestrictedIndex

protected void ensureRestrictedIndex(long index)

Ensures that the given index is nonnegative and smaller than this big-list size.

Parameters:

index - an index.

Throws:

IndexOutOfBoundsException - if the given index is negative or not smaller than this big-list size.

add

public void add(long index,
                boolean k)

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

This implementation always throws an UnsupportedOperationException.

Specified by:

add in interface BooleanBigList

See Also:

BigList.add(long,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 BigList.add(long, Object).

Specified by:

add in interface BooleanCollection

Overrides:

add in class AbstractBooleanCollection

See Also:

Collection.add(Object)

removeBoolean

public boolean removeBoolean(long i)

Removes the element at the specified position.

This implementation always throws an UnsupportedOperationException.

Specified by:

removeBoolean in interface BooleanBigList

See Also:

BigList.remove(long)

set

public boolean set(long index,
                   boolean k)

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

This implementation always throws an UnsupportedOperationException.

Specified by:

set in interface BooleanBigList

See Also:

BigList.set(long,Object)

addAll

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

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

Specified by:

addAll in interface BigList<Boolean>

Parameters:

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

c - collection containing elements to be added to this big list.

Returns:

true if this big list changed as a result of the call

See Also:

List.addAll(int, Collection)

addAll

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

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

Specified by:

addAll in interface Collection<Boolean>

Overrides:

addAll in class AbstractCollection<Boolean>

iterator

public BooleanBigListIterator iterator()

Returns a type-specific iterator on the elements of this collection.

Note that this specification strengthens the one given in Iterable.iterator(), which was already strengthened in the corresponding type-specific class, but was weakened by the fact that this interface extends Collection.

This implementation delegates to listIterator().

Specified by:

iterator in interface BooleanBigList

Specified by:

iterator in interface BooleanCollection

Specified by:

iterator in interface BooleanIterable

Specified by:

iterator in interface Iterable<Boolean>

Specified by:

iterator in interface Collection<Boolean>

Specified by:

iterator in class AbstractBooleanCollection

Returns:

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

See Also:

Iterable.iterator()

listIterator

public BooleanBigListIterator listIterator()

Returns a type-specific big-list iterator on this type-specific big list.

Note that this specification strengthens the one given in BigList.listIterator().

This implementation delegates to listIterator(0).

Specified by:

listIterator in interface BigList<Boolean>

Specified by:

listIterator in interface BooleanBigList

Returns:

a big-list iterator over the elements in this big list.

See Also:

BigList.listIterator()

listIterator

public BooleanBigListIterator listIterator(long index)

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 interface BigList<Boolean>

Specified by:

listIterator in interface BooleanBigList

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)

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:

Collection.contains(Object)

indexOf

public long indexOf(boolean k)

Description copied from interface: BooleanBigList

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 BooleanBigList

See Also:

BigList.indexOf(Object)

lastIndexOf

public long lastIndexOf(boolean k)

Description copied from interface: BooleanBigList

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 BooleanBigList

See Also:

BigList.lastIndexOf(Object)

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

Parameters:

size - the new size.

subList

public BooleanBigList subList(long from,
                              long to)

Description copied from interface: BooleanBigList

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

Note that this specification strengthens the one given in BigList.subList(long,long).

Specified by:

subList in interface BigList<Boolean>

Specified by:

subList in interface BooleanBigList

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)

removeElements

public void removeElements(long from,
                           long to)

Removes (hopefully quickly) elements of this type-specific big 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 BooleanBigList

Parameters:

from - the start index (inclusive).

to - the end index (exclusive).

addElements

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

Add (hopefully quickly) elements to this type-specific big 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 BooleanBigList

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.

addElements

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

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

This implementation delegates to the analogous method for big-array fragments.

Specified by:

addElements in interface BooleanBigList

Parameters:

index - the index at which to add elements.

a - the big array containing the elements.

getElements

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

Copies (hopefully quickly) elements of this type-specific big list into the given big 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 BooleanBigList

Parameters:

from - the start index (inclusive).

a - the destination big array.

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

length - the number of elements to be copied.

clear

public void clear()

This implementation delegates to removeElements(long, long).

Specified by:

clear in interface Collection<Boolean>

Overrides:

clear in class AbstractCollection<Boolean>

size

@Deprecated
public int size()

Deprecated. Please use Size64.size64() instead.

Returns the size of this data structure, minimized with Integer.MAX_VALUE.

This default implementation follows the definition above, which is compatible with Collection.size().

This implementation delegates to Size64.size64().

Specified by:

size in interface BigList<Boolean>

Specified by:

size in interface Size64

Specified by:

size in interface Collection<Boolean>

Specified by:

size in class AbstractCollection<Boolean>

Returns:

the size of this data structure, minimized with Integer.MAX_VALUE.

See Also:

Collection.size()

hashCode

public int hashCode()

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

Specified by:

hashCode in interface Collection<Boolean>

Overrides:

hashCode in class Object

Returns:

the hash code for this big list.

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<Boolean>

Overrides:

equals in class Object

compareTo

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

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

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.

Throws:

ClassCastException - if the argument is not a big 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:

Collection.remove(Object)

addAll

public boolean addAll(long index,
                      BooleanCollection c)

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

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

Specified by:

addAll in interface BooleanBigList

See Also:

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

addAll

public boolean addAll(long index,
                      BooleanBigList l)

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

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

Specified by:

addAll in interface BooleanBigList

See Also:

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

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 addAll(long, 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(BooleanBigList l)

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

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

Specified by:

addAll in interface BooleanBigList

See Also:

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

add

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

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

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

This implementation delegates to the corresponding type-specific method.

Specified by:

add in interface BigList<Boolean>

Specified by:

add in interface BooleanBigList

Parameters:

index - a position in the big list.

ok - an element to be inserted.

See Also:

List.add(int,Object)

set

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

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

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

This implementation delegates to the corresponding type-specific method.

Specified by:

set in interface BigList<Boolean>

Specified by:

set in interface BooleanBigList

Parameters:

index - a position in the big list.

ok - the element to be stored at the specified position.

Returns:

the element previously at the specified positions.

See Also:

List.set(int,Object)

get

@Deprecated
public Boolean get(long index)

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

Returns the element at the specified position.

This implementation delegates to the corresponding type-specific method.

Specified by:

get in interface BigList<Boolean>

Specified by:

get in interface BooleanBigList

Parameters:

index - a position in the big list.

Returns:

the element at the specified position.

See Also:

List.get(int)

indexOf

@Deprecated
public long 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 big list, or -1 if this big list does not contain the element.

This implementation delegates to the corresponding type-specific method.

Specified by:

indexOf in interface BigList<Boolean>

Specified by:

indexOf in interface BooleanBigList

Parameters:

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

@Deprecated
public long 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 big list, or -1 if this big list does not contain the element.

This implementation delegates to the corresponding type-specific method.

Specified by:

lastIndexOf in interface BigList<Boolean>

Specified by:

lastIndexOf in interface BooleanBigList

Parameters:

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

@Deprecated
public Boolean remove(long index)

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

Removes the element at the specified position.

This implementation delegates to the corresponding type-specific method.

Specified by:

remove in interface BigList<Boolean>

Specified by:

remove in interface BooleanBigList

Parameters:

index - a position in the big list.

Returns:

the element previously at the specified position.

See Also:

List.remove(int)

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()

Overrides:

toString in class AbstractBooleanCollection