FastTable (Javolution Core (Java) 6.0.0 API)

java.lang.Object
- javolution.util.FastCollection<E>
- - javolution.util.FastTable<E>

All Implemented Interfaces:: Serializable, Iterable<E>, Collection<E>, Deque<E>, List<E>, Queue<E>, RandomAccess

Direct Known Subclasses:: FastSortedTable

public class FastTable<E>
extends FastCollection<E>
implements List<E>, Deque<E>, RandomAccess

A high-performance table (fractal-based) with real-time behavior.

The fractal-based implementation ensures that add/insertion/deletion operations worst execution time is always in less than O(log(size)). For comparison ArrayList.add is in O(size) due to resize.

Instances of this class can advantageously replace ArrayList, LinkedList or ArrayDeque in terms of adaptability, space or performance. Fast tables can be concurrently iterated / modified through their shared/atomic views. They inherit all the fast collection views and support the subTable view over a portion of the table.

 FastTable<String> names = new FastTable<String>().addAll("John Deuff", "Otto Graf", "Sim Kamil");
 names.sort(Equalities.LEXICAL_CASE_INSENSITIVE); // Sorts the names in place (different from sorted() which returns a sorted view).
 names.subTable(0, names.size() / 2).clear(); // Removes the first half of the table (see java.util.List.subList specification).
 names.filtered(str -> str.startsWith("A")).clear(); // Removes all the names starting with "A" (Java 8 notation).
 names.filtered(str -> str.startsWith("A")).parallel().clear(); // Same as above but performed concurrently.

As for any fast collection, iterations can be performed using closures.

 FastTable<Person> persons = ...
 Person findWithName(final String name) { 
     return persons.filtered(new Predicate<Person>() { 
         public boolean test(Person person) {
             return (person.getName().equals(name));
         }
     }).any(Person.class);
 }

The notation is shorter with Java 8.

 Person findWithName(String name) {
     return persons.filtered(person -> person.getName().equals(name)).any(Person.class);
 }

FastTable iteration order is the insertion order; specialization may have a different order, for example the iteration order of FastSortedTable is based on the table sorting order.

Version:: 6.0, July 21, 2013
Author:: Jean-Marie Dautelle
See Also:: Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class javolution.util.FastCollection
  FastCollection.Format

Constructor Summary

Constructors
Modifier	Constructor and Description
	`FastTable()` Creates an empty table whose capacity increments/decrements smoothly without large resize operations to best fit the table current size.
	`FastTable(Equality<? super E> comparator)` Creates an empty table using the specified comparator for element equality.
`protected`	`FastTable(TableService<E> service)` Creates a fast table backed up by the specified service implementation.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(int index, E element)` Inserts the specified element at the specified position in this table.
`FastTable<E>`	`addAll(E... elements)` Returns this collection with the specified element added.
`FastTable<E>`	`addAll(FastCollection<? extends E> that)` Returns this collection with the specified collection's elements added in sequence.
`boolean`	`addAll(int index, Collection<? extends E> elements)` Inserts all of the elements in the specified collection into this table at the specified position.
`void`	`addFirst(E element)` Inserts the specified element at the front of this table.
`void`	`addLast(E element)` Inserts the specified element at the end of this table.
`FastTable<E>`	`atomic()` Returns an atomic view over this collection.
`void`	`clear()` Removes all elements from this collection.
`Iterator<E>`	`descendingIterator()` Returns an iterator over the elements in this table in reverse sequential order.
`E`	`element()` Retrieves, but does not remove, the head of the queue represented by this table.
`E`	`get(int index)` Returns the element at the specified position in this table.
`E`	`getFirst()` Retrieves, but does not remove, the first element of this table.
`E`	`getLast()` Retrieves, but does not remove, the last element of this table.
`int`	`indexOf(Object element)` Returns the index of the first occurrence of the specified element in this table, or -1 if this table does not contain the element.
`boolean`	`isEmpty()` Indicates if this collection is empty.
`int`	`lastIndexOf(Object element)` Returns the index of the last occurrence of the specified element in this table, or -1 if this table does not contain the element.
`ListIterator<E>`	`listIterator()` Returns a list iterator over the elements in this table.
`ListIterator<E>`	`listIterator(int index)` Returns a list iterator over the elements in this table, starting at the specified position in the table.
`boolean`	`offer(E e)` Inserts the specified element into the queue represented by this table.
`boolean`	`offerFirst(E e)` Inserts the specified element at the front of this table.
`boolean`	`offerLast(E e)` Inserts the specified element at the end of this table.
`E`	`peek()` Retrieves, but does not remove, the head of the queue represented by this table.
`E`	`peekFirst()` Retrieves, but does not remove, the first element of this table, or returns null if this table is empty.
`E`	`peekLast()` Retrieves, but does not remove, the last element of this table, or returns null if this table is empty.
`E`	`poll()` Retrieves and removes the head of the queue represented by this table.
`E`	`pollFirst()` Retrieves and removes the first element of this table, or returns null if this table is empty.
`E`	`pollLast()` .
`E`	`pop()` Pops an element from the stack represented by this table.
`void`	`push(E e)` Pushes an element onto the stack represented by this table.
`E`	`remove()` Retrieves and removes the head of the queue represented by this table.
`E`	`remove(int index)` Removes the element at the specified position in this table.
`E`	`removeFirst()` Retrieves and removes the last element of this table, or returns null if this table is empty.
`boolean`	`removeFirstOccurrence(Object o)` Removes the first occurrence of the specified element from this table.
`E`	`removeLast()` Retrieves and removes the last element of this table.
`boolean`	`removeLastOccurrence(Object o)` Removes the last occurrence of the specified element from this table.
`FastTable<E>`	`reversed()` Returns a view exposing elements in reverse iterative order.
`protected TableService<E>`	`service()` Returns the service implementation of this collection (for sub-classes).
`E`	`set(int index, E element)` Replaces the element at the specified position in this table with the specified element.
`FastTable<E>`	`shared()` Returns a thread-safe view over this collection.
`int`	`size()` Returns the size of this collection.
`void`	`sort()` Sorts this table in place (quick sort).
`FastTable<E>`	`subList(int fromIndex, int toIndex)` Deprecated.
`FastTable<E>`	`subTable(int fromIndex, int toIndex)` Returns a view over a portion of the table (equivalent to `List.subList(int, int)`).
`FastTable<E>`	`unmodifiable()` Returns an unmodifiable view over this collection.

Methods inherited from class javolution.util.FastCollection
add, addAll, any, comparator, contains, containsAll, distinct, equals, filtered, forEach, hashCode, iterator, mapped, max, min, parallel, perform, reduce, remove, removeAll, removeIf, retainAll, sequential, serviceOf, sorted, sorted, toArray, toArray, toImmutable, toString, update

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List
add, addAll, contains, containsAll, equals, hashCode, iterator, remove, removeAll, retainAll, toArray, toArray

Methods inherited from interface java.util.Deque
add, contains, iterator, remove

- Constructor Detail
  - FastTable
```
public FastTable()
```
    Creates an empty table whose capacity increments/decrements smoothly without large resize operations to best fit the table current size.
  - FastTable
```
public FastTable(Equality<? super E> comparator)
```
    Creates an empty table using the specified comparator for element equality.
  - FastTable
```
protected FastTable(TableService<E> service)
```
    Creates a fast table backed up by the specified service implementation.
- Method Detail
  - atomic
```
public FastTable<E> atomic()
```
    Description copied from class: FastCollection
    
    Returns an atomic view over this collection. All operations that write or access multiple elements in the collection (such as addAll(), retainAll()) are atomic. Iterators on atomic collections are thread-safe (no ConcurrentModificationException possible).
    
    Overrides:
    
    atomic in class FastCollection<E>
  - reversed
```
public FastTable<E> reversed()
```
    Description copied from class: FastCollection
    
    Returns a view exposing elements in reverse iterative order.
    
    Overrides:
    
    reversed in class FastCollection<E>
  - shared
```
public FastTable<E> shared()
```
    Description copied from class: FastCollection
    
    Returns a thread-safe view over this collection. The shared view allows for concurrent read as long as there is no writer. The default implementation is based on readers-writers locks giving priority to writers. Iterators on shared collections are thread-safe (no ConcurrentModificationException possible).
    
    Overrides:
    
    shared in class FastCollection<E>
  - unmodifiable
```
public FastTable<E> unmodifiable()
```
    Description copied from class: FastCollection
    
    Returns an unmodifiable view over this collection. Any attempt to modify the collection through this view will result into a UnsupportedOperationException being raised.
    
    Overrides:
    
    unmodifiable in class FastCollection<E>
  - subTable
```
public FastTable<E> subTable(int fromIndex,
                    int toIndex)
```
    Returns a view over a portion of the table (equivalent to List.subList(int, int)).
  - isEmpty
```
@Realtime(limit=CONSTANT)
public boolean isEmpty()
```
    Description copied from class: FastCollection
    
    Indicates if this collection is empty.
    
    Specified by:
    
    isEmpty in interface Collection<E>
    
    Specified by:
    
    isEmpty in interface List<E>
    
    Overrides:
    
    isEmpty in class FastCollection<E>
  - size
```
@Realtime(limit=CONSTANT)
public int size()
```
    Description copied from class: FastCollection
    
    Returns the size of this collection.
    
    Specified by:
    
    size in interface Collection<E>
    
    Specified by:
    
    size in interface Deque<E>
    
    Specified by:
    
    size in interface List<E>
    
    Overrides:
    
    size in class FastCollection<E>
  - clear
```
@Realtime(limit=CONSTANT)
public void clear()
```
    Description copied from class: FastCollection
    
    Removes all elements from this collection.
    
    Specified by:
    
    clear in interface Collection<E>
    
    Specified by:
    
    clear in interface List<E>
    
    Overrides:
    
    clear in class FastCollection<E>
  - add
```
@Realtime(limit=LOG_N)
public void add(int index,
                          E element)
```
    Inserts the specified element at the specified position in this table.
    
    Specified by:
    
    add in interface List<E>
  - addAll
```
@Realtime(limit=N_LOG_N)
public boolean addAll(int index,
                                  Collection<? extends E> elements)
```
    Inserts all of the elements in the specified collection into this table at the specified position.
    
    Specified by:
    
    addAll in interface List<E>
  - remove
```
@Realtime(limit=LOG_N)
public E remove(int index)
```
    Removes the element at the specified position in this table.
    
    Specified by:
    
    remove in interface List<E>
  - get
```
@Realtime(limit=CONSTANT)
public E get(int index)
```
    Returns the element at the specified position in this table.
    
    Specified by:
    
    get in interface List<E>
  - set
```
@Realtime(limit=CONSTANT)
public E set(int index,
                          E element)
```
    Replaces the element at the specified position in this table with the specified element.
    
    Specified by:
    
    set in interface List<E>
  - indexOf
```
@Realtime(limit=LINEAR)
public int indexOf(Object element)
```
    Returns the index of the first occurrence of the specified element in this table, or -1 if this table does not contain the element.
    
    Specified by:
    
    indexOf in interface List<E>
  - lastIndexOf
```
@Realtime(limit=LINEAR)
public int lastIndexOf(Object element)
```
    Returns the index of the last occurrence of the specified element in this table, or -1 if this table does not contain the element.
    
    Specified by:
    
    lastIndexOf in interface List<E>
  - listIterator
```
@Realtime(limit=CONSTANT)
public ListIterator<E> listIterator()
```
    Returns a list iterator over the elements in this table.
    
    Specified by:
    
    listIterator in interface List<E>
  - listIterator
```
@Realtime(limit=CONSTANT)
public ListIterator<E> listIterator(int index)
```
    Returns a list iterator over the elements in this table, starting at the specified position in the table.
    
    Specified by:
    
    listIterator in interface List<E>
  - addFirst
```
@Realtime(limit=CONSTANT)
public void addFirst(E element)
```
    Inserts the specified element at the front of this table.
    
    Specified by:
    
    addFirst in interface Deque<E>
  - addLast
```
@Realtime(limit=CONSTANT)
public void addLast(E element)
```
    Inserts the specified element at the end of this table.
    
    Specified by:
    
    addLast in interface Deque<E>
  - getFirst
```
@Realtime(limit=CONSTANT)
public E getFirst()
```
    Retrieves, but does not remove, the first element of this table.
    
    Specified by:
    
    getFirst in interface Deque<E>
  - getLast
```
@Realtime(limit=CONSTANT)
public E getLast()
```
    Retrieves, but does not remove, the last element of this table.
    
    Specified by:
    
    getLast in interface Deque<E>
  - peekFirst
```
@Realtime(limit=CONSTANT)
public E peekFirst()
```
    Retrieves, but does not remove, the first element of this table, or returns null if this table is empty.
    
    Specified by:
    
    peekFirst in interface Deque<E>
  - peekLast
```
@Realtime(limit=CONSTANT)
public E peekLast()
```
    Retrieves, but does not remove, the last element of this table, or returns null if this table is empty.
    
    Specified by:
    
    peekLast in interface Deque<E>
  - pollFirst
```
@Realtime(limit=CONSTANT)
public E pollFirst()
```
    Retrieves and removes the first element of this table, or returns null if this table is empty.
    
    Specified by:
    
    pollFirst in interface Deque<E>
  - pollLast
```
@Realtime(limit=CONSTANT)
public E pollLast()
```
    .
    
    Specified by:
    
    pollLast in interface Deque<E>
  - removeFirst
```
@Realtime(limit=CONSTANT)
public E removeFirst()
```
    Retrieves and removes the last element of this table, or returns null if this table is empty.
    
    Specified by:
    
    removeFirst in interface Deque<E>
  - removeLast
```
@Realtime(limit=CONSTANT)
public E removeLast()
```
    Retrieves and removes the last element of this table.
    
    Specified by:
    
    removeLast in interface Deque<E>
  - offerFirst
```
@Realtime(limit=CONSTANT)
public boolean offerFirst(E e)
```
    Inserts the specified element at the front of this table.
    
    Specified by:
    
    offerFirst in interface Deque<E>
  - offerLast
```
@Realtime(limit=CONSTANT)
public boolean offerLast(E e)
```
    Inserts the specified element at the end of this table.
    
    Specified by:
    
    offerLast in interface Deque<E>
  - removeFirstOccurrence
```
@Realtime(limit=LINEAR)
public boolean removeFirstOccurrence(Object o)
```
    Removes the first occurrence of the specified element from this table.
    
    Specified by:
    
    removeFirstOccurrence in interface Deque<E>
  - removeLastOccurrence
```
@Realtime(limit=LINEAR)
public boolean removeLastOccurrence(Object o)
```
    Removes the last occurrence of the specified element from this table.
    
    Specified by:
    
    removeLastOccurrence in interface Deque<E>
  - offer
```
@Realtime(limit=CONSTANT)
public boolean offer(E e)
```
    Inserts the specified element into the queue represented by this table.
    
    Specified by:
    
    offer in interface Deque<E>
    
    Specified by:
    
    offer in interface Queue<E>
  - remove
```
@Realtime(limit=CONSTANT)
public E remove()
```
    Retrieves and removes the head of the queue represented by this table.
    
    Specified by:
    
    remove in interface Deque<E>
    
    Specified by:
    
    remove in interface Queue<E>
  - poll
```
@Realtime(limit=CONSTANT)
public E poll()
```
    Retrieves and removes the head of the queue represented by this table.
    
    Specified by:
    
    poll in interface Deque<E>
    
    Specified by:
    
    poll in interface Queue<E>
  - element
```
@Realtime(limit=CONSTANT)
public E element()
```
    Retrieves, but does not remove, the head of the queue represented by this table.
    
    Specified by:
    
    element in interface Deque<E>
    
    Specified by:
    
    element in interface Queue<E>
  - peek
```
@Realtime(limit=CONSTANT)
public E peek()
```
    Retrieves, but does not remove, the head of the queue represented by this table.
    
    Specified by:
    
    peek in interface Deque<E>
    
    Specified by:
    
    peek in interface Queue<E>
  - push
```
@Realtime(limit=CONSTANT)
public void push(E e)
```
    Pushes an element onto the stack represented by this table.
    
    Specified by:
    
    push in interface Deque<E>
  - pop
```
@Realtime(limit=CONSTANT)
public E pop()
```
    Pops an element from the stack represented by this table.
    
    Specified by:
    
    pop in interface Deque<E>
  - descendingIterator
```
@Realtime(limit=CONSTANT)
public Iterator<E> descendingIterator()
```
    Returns an iterator over the elements in this table in reverse sequential order.
    
    Specified by:
    
    descendingIterator in interface Deque<E>
  - sort
```
@Realtime(limit=N_SQUARE)
public void sort()
```
    Sorts this table in place (quick sort).
  - addAll
```
@Realtime(limit=LINEAR)
public FastTable<E> addAll(E... elements)
```
    Description copied from class: FastCollection
    
    Returns this collection with the specified element added.
    
    Overrides:
    
    addAll in class FastCollection<E>
    
    Parameters:
    elements - the elements to be added.
    
    Returns:
    this
  - addAll
```
@Realtime(limit=LINEAR)
public FastTable<E> addAll(FastCollection<? extends E> that)
```
    Description copied from class: FastCollection
    
    Returns this collection with the specified collection's elements added in sequence.
    
    Overrides:
    
    addAll in class FastCollection<E>
  - subList
```
@Deprecated
public FastTable<E> subList(int fromIndex,
                              int toIndex)
```
    Deprecated.
    
    Replaced by subTable(int, int). The term "List" for an interface with random access is disturbing !
    
    Specified by:
    
    subList in interface List<E>
  - service
```
protected TableService<E> service()
```
    Description copied from class: FastCollection
    
    Returns the service implementation of this collection (for sub-classes).
    
    Specified by:
    
    service in class FastCollection<E>

Class FastTable<E>

Nested Class Summary

Nested classes/interfaces inherited from class javolution.util.FastCollection

Constructor Summary

Method Summary

Methods inherited from class javolution.util.FastCollection

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Deque

Constructor Detail

FastTable

FastTable

FastTable

Method Detail

atomic

reversed

shared

unmodifiable

subTable

isEmpty

size

clear

add

addAll

remove

get

set

indexOf

lastIndexOf

listIterator

listIterator

addFirst

addLast

getFirst

getLast

peekFirst

peekLast

pollFirst

pollLast

removeFirst

removeLast

offerFirst

offerLast

removeFirstOccurrence

removeLastOccurrence

offer

remove

poll

element

peek

push

pop

descendingIterator

sort

addAll

addAll

subList

service