it.unimi.dsi.fastutil.bytes
Class AbstractByteBigList

java.lang.Object
  extended by java.util.AbstractCollection<Byte>
      extended by it.unimi.dsi.fastutil.bytes.AbstractByteCollection
          extended by it.unimi.dsi.fastutil.bytes.AbstractByteBigList
All Implemented Interfaces:
BigList<Byte>, ByteBigList, ByteCollection, ByteIterable, ByteStack, Size64, Stack<Byte>, Comparable<BigList<? extends Byte>>, Iterable<Byte>, Collection<Byte>
Direct Known Subclasses:
AbstractByteBigList.ByteSubList, ByteBigArrayBigList, ByteBigLists.ListBigList, ByteBigLists.Singleton

public abstract class AbstractByteBigList
extends AbstractByteCollection
implements ByteBigList, ByteStack

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


Nested Class Summary
static class AbstractByteBigList.ByteSubList
           
 
Method Summary
 boolean add(byte k)
           
 void add(long index, byte k)
           
 void add(long index, Byte ok)
          Delegates to the corresponding type-specific method.
 boolean addAll(ByteBigList l)
           
 boolean addAll(ByteCollection c)
          Adds all elements of the given type-specific collection to this collection.
 boolean addAll(Collection<? extends Byte> c)
          Delegates to a more generic method.
 boolean addAll(int index, Collection<? extends Byte> c)
           
 boolean addAll(long index, ByteBigList l)
          Delegates to a more generic method.
 boolean addAll(long index, ByteCollection c)
          Delegates to a more generic method.
 boolean addAll(long index, Collection<? extends Byte> c)
          Inserts all of the elements in the specified collection into this big list at the specified position (optional operation).
 void addElements(long index, byte[][] a)
          Add (hopefully quickly) elements to this type-specific big list.
 void addElements(long index, byte[][] a, long offset, long length)
          Adds elements to this type-specific big list one-by-one.
 int compareTo(BigList<? extends Byte> l)
          Compares this big list to another object.
 boolean contains(byte k)
           
 boolean equals(Object o)
           
 Byte get(long index)
          Delegates to the corresponding type-specific method.
 byte getByte(int index)
           
 void getElements(long from, byte[][] a, long offset, long length)
          Copies element of this type-specific big list into the given big array one-by-one.
 int hashCode()
          Returns the hash code for this big list, which is identical to List.hashCode().
 long indexOf(byte k)
           
 long indexOf(Object ok)
          Delegates to the corresponding type-specific method.
 ByteBigListIterator iterator()
          Returns a type-specific iterator on the elements of this collection.
 long lastIndexOf(byte k)
           
 long lastIndexOf(Object ok)
          Delegates to the corresponding type-specific method.
 ByteBigListIterator listIterator()
          Returns a type-specific big-list iterator on this type-specific big list.
 ByteBigListIterator listIterator(int index)
           
 ByteBigListIterator listIterator(long index)
          Returns a type-specific list iterator on this type-specific big list starting at a given index.
 Byte peek(int i)
          Delegates to the corresponding type-specific method.
 byte peekByte(int i)
           
 Byte pop()
          Delegates to the corresponding type-specific method.
 byte popByte()
           
 void push(byte o)
           
 void push(Byte o)
          Delegates to the corresponding type-specific method.
 boolean rem(byte 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.
 Byte remove(int index)
          Delegates to the corresponding type-specific method.
 Byte remove(long index)
          Delegates to the corresponding type-specific method.
 byte removeByte(int i)
           
 byte removeByte(long i)
           
 void removeElements(long from, long to)
          Removes elements of this type-specific big list one-by-one.
 byte set(int index, byte k)
           
 byte set(long index, byte k)
           
 Byte set(long index, Byte ok)
          Delegates to the corresponding type-specific method.
 int size()
          Deprecated. 
 void size(int size)
           
 void size(long size)
          Sets the size of this big list.
 ByteBigList 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.
 Byte top()
          Delegates to the corresponding type-specific method.
 byte topByte()
           
 String toString()
           
 
Methods inherited from class it.unimi.dsi.fastutil.bytes.AbstractByteCollection
add, byteIterator, contains, containsAll, containsAll, isEmpty, rem, remove, removeAll, removeAll, retainAll, retainAll, toArray, toArray, toArray, toByteArray, toByteArray
 
Methods inherited from class java.util.AbstractCollection
clear
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface it.unimi.dsi.fastutil.bytes.ByteBigList
getByte
 
Methods inherited from interface it.unimi.dsi.fastutil.Size64
size64
 
Methods inherited from interface it.unimi.dsi.fastutil.bytes.ByteCollection
byteIterator, containsAll, removeAll, retainAll, toArray, toArray, toByteArray, toByteArray
 
Methods inherited from interface java.util.Collection
add, clear, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray
 
Methods inherited from interface it.unimi.dsi.fastutil.Stack
isEmpty
 

Method Detail

add

public void add(long index,
                byte k)
Specified by:
add in interface ByteBigList
See Also:
List.add(int,Object)

add

public boolean add(byte k)
Specified by:
add in interface ByteCollection
Overrides:
add in class AbstractByteCollection
See Also:
Collection.add(Object)

removeByte

public byte removeByte(long i)
Specified by:
removeByte in interface ByteBigList
See Also:
BigList.remove(long)

removeByte

public byte removeByte(int i)

set

public byte set(long index,
                byte k)
Specified by:
set in interface ByteBigList
See Also:
BigList.set(long,Object)

set

public byte set(int index,
                byte k)

addAll

public boolean addAll(long index,
                      Collection<? extends Byte> c)
Description copied from interface: BigList
Inserts all of the elements in the specified collection into this big list at the specified position (optional operation).

Specified by:
addAll in interface BigList<Byte>
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(int index,
                      Collection<? extends Byte> c)

addAll

public boolean addAll(Collection<? extends Byte> c)
Delegates to a more generic method.

Specified by:
addAll in interface Collection<Byte>
Overrides:
addAll in class AbstractByteCollection
Parameters:
c - a collection.
Returns:
true if this collection changed as a result of the call.

iterator

public ByteBigListIterator iterator()
Description copied from interface: ByteCollection
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.

Specified by:
iterator in interface ByteBigList
Specified by:
iterator in interface ByteCollection
Specified by:
iterator in interface ByteIterable
Specified by:
iterator in interface Iterable<Byte>
Specified by:
iterator in interface Collection<Byte>
Specified by:
iterator in class AbstractByteCollection
Returns:
a type-specific iterator on the elements of this collection.
See Also:
List.iterator()

listIterator

public ByteBigListIterator listIterator()
Description copied from interface: ByteBigList
Returns a type-specific big-list iterator on this type-specific big list.

Specified by:
listIterator in interface BigList<Byte>
Specified by:
listIterator in interface ByteBigList
Returns:
a big-list iterator over the elements in this big list.
See Also:
List.listIterator()

listIterator

public ByteBigListIterator listIterator(long index)
Description copied from interface: ByteBigList
Returns a type-specific list iterator on this type-specific big list starting at a given index.

Specified by:
listIterator in interface BigList<Byte>
Specified by:
listIterator in interface ByteBigList
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)

listIterator

public ByteBigListIterator listIterator(int index)

contains

public boolean contains(byte k)
Specified by:
contains in interface ByteCollection
Overrides:
contains in class AbstractByteCollection
See Also:
Collection.contains(Object)

indexOf

public long indexOf(byte k)
Specified by:
indexOf in interface ByteBigList
See Also:
BigList.indexOf(Object)

lastIndexOf

public long lastIndexOf(byte k)
Specified by:
lastIndexOf in interface ByteBigList
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<Byte>
Parameters:
size - the new size.

size

public void size(int size)

subList

public ByteBigList subList(long from,
                           long to)
Description copied from interface: ByteBigList
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<Byte>
Specified by:
subList in interface ByteBigList
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 elements of this type-specific big list one-by-one.

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 ByteBigList
Parameters:
from - the start index (inclusive).
to - the end index (exclusive).

addElements

public void addElements(long index,
                        byte[][] a,
                        long offset,
                        long length)
Adds elements to this type-specific big list one-by-one.

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 ByteBigList
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,
                        byte[][] a)
Description copied from interface: ByteBigList
Add (hopefully quickly) elements to this type-specific big list.

Specified by:
addElements in interface ByteBigList
Parameters:
index - the index at which to add elements.
a - the big array containing the elements.

getElements

public void getElements(long from,
                        byte[][] a,
                        long offset,
                        long length)
Copies element of this type-specific big list into the given big array one-by-one.

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 ByteBigList
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.

size

@Deprecated
public int size()
Deprecated. 

Description copied from interface: Size64
Returns the size of this data structure, minimized with Integer.MAX_VALUE.

Specified by:
size in interface Size64
Specified by:
size in interface Collection<Byte>
Specified by:
size in class AbstractCollection<Byte>
Returns:
the size of this data structure, minimized with Integer.MAX_VALUE.
See Also:
Collection.size()

equals

public boolean equals(Object o)
Specified by:
equals in interface Collection<Byte>
Overrides:
equals in class Object

compareTo

public int compareTo(BigList<? extends Byte> 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 Byte>>
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.

hashCode

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

Specified by:
hashCode in interface Collection<Byte>
Overrides:
hashCode in class Object
Returns:
the hash code for this big list.

push

public void push(byte o)
Specified by:
push in interface ByteStack
See Also:
Stack.push(Object)

popByte

public byte popByte()
Specified by:
popByte in interface ByteStack
See Also:
Stack.pop()

topByte

public byte topByte()
Specified by:
topByte in interface ByteStack
See Also:
Stack.top()

peekByte

public byte peekByte(int i)
Specified by:
peekByte in interface ByteStack
See Also:
Stack.peek(int)

getByte

public byte getByte(int index)

rem

public boolean rem(byte k)
Description copied from interface: ByteCollection
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 ByteCollection
Overrides:
rem in class AbstractByteCollection
See Also:
Collection.remove(Object)

addAll

public boolean addAll(long index,
                      ByteCollection c)
Delegates to a more generic method.

Specified by:
addAll in interface ByteBigList
See Also:
List.addAll(int,java.util.Collection)

addAll

public boolean addAll(long index,
                      ByteBigList l)
Delegates to a more generic method.

Specified by:
addAll in interface ByteBigList
See Also:
List.addAll(int,java.util.Collection)

addAll

public boolean addAll(ByteCollection c)
Description copied from class: AbstractByteCollection
Adds all elements of the given type-specific collection to this collection.

Specified by:
addAll in interface ByteCollection
Overrides:
addAll in class AbstractByteCollection
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(ByteBigList l)
Specified by:
addAll in interface ByteBigList
See Also:
List.addAll(int,java.util.Collection)

add

public void add(long index,
                Byte ok)
Delegates to the corresponding type-specific method.

Specified by:
add in interface BigList<Byte>
Parameters:
index - a position in the big list.
ok - an element to be inserted.
See Also:
List.add(int,Object)

set

public Byte set(long index,
                Byte ok)
Delegates to the corresponding type-specific method.

Specified by:
set in interface BigList<Byte>
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

public Byte get(long index)
Delegates to the corresponding type-specific method.

Specified by:
get in interface BigList<Byte>
Parameters:
index - a position in the big list.
Returns:
the element at the specified position.
See Also:
List.get(int)

indexOf

public long indexOf(Object ok)
Delegates to the corresponding type-specific method.

Specified by:
indexOf in interface BigList<Byte>
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

public long lastIndexOf(Object ok)
Delegates to the corresponding type-specific method.

Specified by:
lastIndexOf in interface BigList<Byte>
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

public Byte remove(int index)
Delegates to the corresponding type-specific method.


remove

public Byte remove(long index)
Delegates to the corresponding type-specific method.

Specified by:
remove in interface BigList<Byte>
Parameters:
index - a position in the big list.
Returns:
the element previously at the specified position.
See Also:
List.remove(int)

push

public void push(Byte o)
Delegates to the corresponding type-specific method.

Specified by:
push in interface Stack<Byte>
Parameters:
o - the object that will become the new top of the stack.

pop

public Byte pop()
Delegates to the corresponding type-specific method.

Specified by:
pop in interface Stack<Byte>
Returns:
the top of the stack.

top

public Byte top()
Delegates to the corresponding type-specific method.

Specified by:
top in interface Stack<Byte>
Returns:
the top of the stack.

peek

public Byte peek(int i)
Delegates to the corresponding type-specific method.

Specified by:
peek in interface Stack<Byte>
Returns:
the i-th element on the stack; 0 represents the top.

toString

public String toString()
Overrides:
toString in class AbstractByteCollection