com.github.andrewoma.dexx.collection
Class Vector<E>

java.lang.Object
  com.github.andrewoma.dexx.collection.internal.base.AbstractTraversable<E>
      com.github.andrewoma.dexx.collection.internal.base.AbstractIterable<E>
          com.github.andrewoma.dexx.collection.internal.base.AbstractList<E>
              com.github.andrewoma.dexx.collection.internal.base.AbstractIndexedList<E>
                  com.github.andrewoma.dexx.collection.Vector<E>

All Implemented Interfaces:

IndexedList<E>, List<E>, Traversable<E>, Iterable<E>

public class Vector<E>
extends AbstractIndexedList<E>

Vector is a general-purpose, immutable data structure.

It provides random access and updates in effectively constant time, as well as very fast append and prepend.

It is backed by a little endian bit-mapped vector trie with a branching factor of 32. Locality is very good, but not contiguous, which is good for very large sequences.

See Scala's documentation for more information on the implementation.

Field Summary

protected com.github.andrewoma.dexx.collection.VectorPointer<E>

pointer

Method Summary

Vector<E>	append(E value) Returns a list with the specified element appended to the bottom of the list.
Vector<E>	drop(int n) Returns a list containing all elements in this list, excluding the first number of elements.
static <E> Vector<E>	empty()
static <E> BuilderFactory<E,Vector<E>>	factory()
E	first() Returns first element in the list or null if the list is empty.
E	get(int index) Returns the element at the specified index in this list (zero-based).
boolean	isEmpty() Returns true if this collection is empty.
Iterator<E>	iterator()
E	last() Returns last element in the list or null if the list is empty.
Vector<E>	prepend(E value) Returns a list with the specified element prepended to the top of the list.
Vector<E>	range(int from, boolean fromInclusive, int to, boolean toInclusive) Returns a list containing a contiguous range of elements from this list.
Vector<E>	set(int index, E elem) Returns a list with the element set to the value specified at the index (zero-based).
int	size() Returns the size of the collection.
protected Pair<Vector<E>,Vector<E>>	splitAt(int n)
Vector<E>	tail() Returns a list containing all elements in the list, excluding the first element.
Vector<E>	take(int n) Returns a list containing the first number of elements from this list.

Methods inherited from class com.github.andrewoma.dexx.collection.internal.base.AbstractList

asList, equals, hashCode, indexOf, lastIndexOf

Methods inherited from class com.github.andrewoma.dexx.collection.internal.base.AbstractIterable

forEach

Methods inherited from class com.github.andrewoma.dexx.collection.internal.base.AbstractTraversable

makeString, makeString, to, toArray, toArray, toIndexedList, toSet, toSortedSet, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.andrewoma.dexx.collection.List

asList, indexOf, lastIndexOf

Methods inherited from interface com.github.andrewoma.dexx.collection.Traversable

forEach, makeString, makeString, to, toArray, toArray, toIndexedList, toSet, toSortedSet

Field Detail

pointer

protected final com.github.andrewoma.dexx.collection.VectorPointer<E> pointer

Method Detail

factory

@NotNull
public static <E> BuilderFactory<E,Vector<E>> factory()

empty

@NotNull
public static <E> Vector<E> empty()

size

public int size()

Description copied from interface: Traversable

Returns the size of the collection.

Warning: infinite collections are possible, as are collections that require traversal to calculate the size.

Specified by:

size in interface Traversable<E>

Overrides:

size in class AbstractTraversable<E>

iterator

@NotNull
public Iterator<E> iterator()

get

public E get(int index)

Description copied from interface: List

Returns the element at the specified index in this list (zero-based).

take

@NotNull
public Vector<E> take(int n)

Description copied from interface: List

Returns a list containing the first number of elements from this list.

drop

@NotNull
public Vector<E> drop(int n)

Description copied from interface: List

Returns a list containing all elements in this list, excluding the first number of elements.

isEmpty

public boolean isEmpty()

Description copied from interface: Traversable

Returns true if this collection is empty.

Specified by:

isEmpty in interface Traversable<E>

Overrides:

isEmpty in class AbstractTraversable<E>

first

@Nullable
public E first()

Description copied from interface: List

Returns first element in the list or null if the list is empty.

tail

@NotNull
public Vector<E> tail()

Description copied from interface: List

Returns a list containing all elements in the list, excluding the first element. An empty list is returned if the list is empty.

last

@Nullable
public E last()

Description copied from interface: List

Returns last element in the list or null if the list is empty.

range

@NotNull
public Vector<E> range(int from,
                               boolean fromInclusive,
                               int to,
                               boolean toInclusive)

Description copied from interface: List

Returns a list containing a contiguous range of elements from this list.

Parameters:

from - starting index for the range (zero-based)

fromInclusive - if true, the element at the from index will be included

to - end index for the range (zero-based)

toInclusive - if true, the element at the to index will be included

splitAt

@NotNull
protected Pair<Vector<E>,Vector<E>> splitAt(int n)

set

@NotNull
public Vector<E> set(int index,
                             E elem)

Description copied from interface: List

Returns a list with the element set to the value specified at the index (zero-based).

prepend

@NotNull
public Vector<E> prepend(E value)

Description copied from interface: List

Returns a list with the specified element prepended to the top of the list.

append

@NotNull
public Vector<E> append(E value)

Description copied from interface: List

Returns a list with the specified element appended to the bottom of the list.