it.unimi.dsi.fastutil.chars
Class AbstractCharBigList

java.lang.Object
  extended by java.util.AbstractCollection<java.lang.Character>
      extended by it.unimi.dsi.fastutil.chars.AbstractCharCollection
          extended by it.unimi.dsi.fastutil.chars.AbstractCharBigList
All Implemented Interfaces:
BigList<java.lang.Character>, CharBigList, CharCollection, CharIterable, CharStack, Size64, Stack<java.lang.Character>, java.lang.Comparable<BigList<? extends java.lang.Character>>, java.lang.Iterable<java.lang.Character>, java.util.Collection<java.lang.Character>
Direct Known Subclasses:
AbstractCharBigList.CharSubList, CharBigArrayBigList, CharBigLists.ListBigList, CharBigLists.Singleton

public abstract class AbstractCharBigList
extends AbstractCharCollection
implements CharBigList, CharStack

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


Nested Class Summary
static class AbstractCharBigList.CharSubList
           
 
Method Summary
 boolean add(char k)
           
 void add(long index, char k)
           
 void add(long index, java.lang.Character ok)
          Delegates to the corresponding type-specific method.
 boolean addAll(CharBigList l)
           
 boolean addAll(CharCollection c)
          Adds all elements of the given type-specific collection to this collection.
 boolean addAll(java.util.Collection<? extends java.lang.Character> c)
          Delegates to a more generic method.
 boolean addAll(int index, java.util.Collection<? extends java.lang.Character> c)
           
 boolean addAll(long index, CharBigList l)
          Delegates to a more generic method.
 boolean addAll(long index, CharCollection c)
          Delegates to a more generic method.
 boolean addAll(long index, java.util.Collection<? extends java.lang.Character> c)
          Inserts all of the elements in the specified collection into this big list at the specified position (optional operation).
 void addElements(long index, char[][] a)
          Add (hopefully quickly) elements to this type-specific big list.
 void addElements(long index, char[][] a, long offset, long length)
          Adds elements to this type-specific big list one-by-one.
 int compareTo(BigList<? extends java.lang.Character> l)
          Compares this big list to another object.
 boolean contains(char k)
           
 boolean equals(java.lang.Object o)
           
 java.lang.Character get(long index)
          Delegates to the corresponding type-specific method.
 char getChar(int index)
           
 void getElements(long from, char[][] 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(char k)
           
 long indexOf(java.lang.Object ok)
          Delegates to the corresponding type-specific method.
 CharBigListIterator iterator()
          Returns a type-specific iterator on the elements of this collection.
 long lastIndexOf(char k)
           
 long lastIndexOf(java.lang.Object ok)
          Delegates to the corresponding type-specific method.
 CharBigListIterator listIterator()
          Returns a type-specific big-list iterator on this type-specific big list.
 CharBigListIterator listIterator(int index)
           
 CharBigListIterator listIterator(long index)
          Returns a type-specific list iterator on this type-specific big list starting at a given index.
 java.lang.Character peek(int i)
          Delegates to the corresponding type-specific method.
 char peekChar(int i)
           
 java.lang.Character pop()
          Delegates to the corresponding type-specific method.
 char popChar()
           
 void push(char o)
           
 void push(java.lang.Character o)
          Delegates to the corresponding type-specific method.
 boolean rem(char 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.
 java.lang.Character remove(int index)
          Delegates to the corresponding type-specific method.
 java.lang.Character remove(long index)
          Delegates to the corresponding type-specific method.
 char removeChar(int i)
           
 char removeChar(long i)
           
 void removeElements(long from, long to)
          Removes elements of this type-specific big list one-by-one.
 char set(int index, char k)
           
 char set(long index, char k)
           
 java.lang.Character set(long index, java.lang.Character 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.
 CharBigList 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.
 java.lang.Character top()
          Delegates to the corresponding type-specific method.
 char topChar()
           
 java.lang.String toString()
           
 
Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractCharCollection
add, charIterator, contains, containsAll, containsAll, isEmpty, rem, remove, removeAll, removeAll, retainAll, retainAll, toArray, toArray, toArray, toCharArray, toCharArray
 
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.chars.CharBigList
getChar
 
Methods inherited from interface it.unimi.dsi.fastutil.Size64
size64
 
Methods inherited from interface it.unimi.dsi.fastutil.chars.CharCollection
charIterator, containsAll, removeAll, retainAll, toArray, toArray, toCharArray, toCharArray
 
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,
                char k)
Specified by:
add in interface CharBigList
See Also:
List.add(int,Object)

add

public boolean add(char k)
Specified by:
add in interface CharCollection
Overrides:
add in class AbstractCharCollection
See Also:
Collection.add(Object)

removeChar

public char removeChar(long i)
Specified by:
removeChar in interface CharBigList
See Also:
BigList.remove(long)

removeChar

public char removeChar(int i)

set

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

set

public char set(int index,
                char k)

addAll

public boolean addAll(long index,
                      java.util.Collection<? extends java.lang.Character> 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<java.lang.Character>
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,
                      java.util.Collection<? extends java.lang.Character> c)

addAll

public boolean addAll(java.util.Collection<? extends java.lang.Character> c)
Delegates to a more generic method.

Specified by:
addAll in interface java.util.Collection<java.lang.Character>
Overrides:
addAll in class AbstractCharCollection
Parameters:
c - a collection.
Returns:
true if this collection changed as a result of the call.

iterator

public CharBigListIterator iterator()
Description copied from interface: CharCollection
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 CharBigList
Specified by:
iterator in interface CharCollection
Specified by:
iterator in interface CharIterable
Specified by:
iterator in interface java.lang.Iterable<java.lang.Character>
Specified by:
iterator in interface java.util.Collection<java.lang.Character>
Specified by:
iterator in class AbstractCharCollection
Returns:
a type-specific iterator on the elements of this collection.
See Also:
List.iterator()

listIterator

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

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

listIterator

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

Specified by:
listIterator in interface BigList<java.lang.Character>
Specified by:
listIterator in interface CharBigList
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 CharBigListIterator listIterator(int index)

contains

public boolean contains(char k)
Specified by:
contains in interface CharCollection
Overrides:
contains in class AbstractCharCollection
See Also:
Collection.contains(Object)

indexOf

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

lastIndexOf

public long lastIndexOf(char k)
Specified by:
lastIndexOf in interface CharBigList
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<java.lang.Character>
Parameters:
size - the new size.

size

public void size(int size)

subList

public CharBigList subList(long from,
                           long to)
Description copied from interface: CharBigList
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<java.lang.Character>
Specified by:
subList in interface CharBigList
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 CharBigList
Parameters:
from - the start index (inclusive).
to - the end index (exclusive).

addElements

public void addElements(long index,
                        char[][] 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 CharBigList
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,
                        char[][] a)
Description copied from interface: CharBigList
Add (hopefully quickly) elements to this type-specific big list.

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

getElements

public void getElements(long from,
                        char[][] 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 CharBigList
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 java.util.Collection<java.lang.Character>
Specified by:
size in class java.util.AbstractCollection<java.lang.Character>
Returns:
the size of this data structure, minimized with Integer.MAX_VALUE.
See Also:
Collection.size()

equals

public boolean equals(java.lang.Object o)
Specified by:
equals in interface java.util.Collection<java.lang.Character>
Overrides:
equals in class java.lang.Object

compareTo

public int compareTo(BigList<? extends java.lang.Character> 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 java.lang.Comparable<BigList<? extends java.lang.Character>>
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:
java.lang.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 java.util.Collection<java.lang.Character>
Overrides:
hashCode in class java.lang.Object
Returns:
the hash code for this big list.

push

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

popChar

public char popChar()
Specified by:
popChar in interface CharStack
See Also:
Stack.pop()

topChar

public char topChar()
Specified by:
topChar in interface CharStack
See Also:
Stack.top()

peekChar

public char peekChar(int i)
Specified by:
peekChar in interface CharStack
See Also:
Stack.peek(int)

getChar

public char getChar(int index)

rem

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

addAll

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

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

addAll

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

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

addAll

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

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

add

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

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

set

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

Specified by:
set in interface BigList<java.lang.Character>
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 java.lang.Character get(long index)
Delegates to the corresponding type-specific method.

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

indexOf

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

Specified by:
indexOf in interface BigList<java.lang.Character>
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(java.lang.Object ok)
Delegates to the corresponding type-specific method.

Specified by:
lastIndexOf in interface BigList<java.lang.Character>
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 java.lang.Character remove(int index)
Delegates to the corresponding type-specific method.


remove

public java.lang.Character remove(long index)
Delegates to the corresponding type-specific method.

Specified by:
remove in interface BigList<java.lang.Character>
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(java.lang.Character o)
Delegates to the corresponding type-specific method.

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

pop

public java.lang.Character pop()
Delegates to the corresponding type-specific method.

Specified by:
pop in interface Stack<java.lang.Character>
Returns:
the top of the stack.

top

public java.lang.Character top()
Delegates to the corresponding type-specific method.

Specified by:
top in interface Stack<java.lang.Character>
Returns:
the top of the stack.

peek

public java.lang.Character peek(int i)
Delegates to the corresponding type-specific method.

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

toString

public java.lang.String toString()
Overrides:
toString in class AbstractCharCollection