org.genantics.list

Class CodedList<V>

java.lang.Object

org.genantics.list.CodedList<V>

All Implemented Interfaces:

Iterable<V>, Access<V>, CList<V>

public class CodedList<V>
extends Object
implements CList<V>

CodedList implements a "CDR-coded" list. For large lists, CodedList should have significant performance advantages over ConsList:

• size() is an O(1) operation.
• List traversals have better cache locality* (even more so when the iterator() or visit methods are used)

* - The element references are stored contiguously in arrays; true cache locality (elements stored in contiguously in arrays) will have to wait for value types.

Use CList.NIL for nil.

Author:

Bob Foster

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	CodedList.CListIterator<V>
protected class	CodedList.CListReverseIterator<V>

Field Summary

Fields inherited from interface org.genantics.list.CList

NIL

Fields inherited from interface org.genantics.access.Access

JAVA_8

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CodedList(CodedList<V> other)
protected	CodedList(V element, CList<V> list) Constructor.
protected	CodedList(V element, CodedList<V> list, int pos)

Method Summary

Methods

Modifier and Type	Method and Description
CList<V>	cons(V element) Add an element to the head of the list.
boolean	contains(V element) Test for element.
protected boolean	contains(V element, int pos)
V	head() Get the head of the list.
boolean	isEmpty() Test if empty.
Iterator<V>	iterator() Iterate through the elements in the list.
Iterator<V>	reverseIterator() Get the elements in reverse order.
boolean	reverseVisit(ConditionalVisitor<V> visitor) Visit all elements in reverse order until visitor.visit() returns true;
protected boolean	reverseVisit(ConditionalVisitor<V> visitor, int pos, CList<V> last)
void	reverseVisit(Visitor<V> visitor) Visit all elements in reverse order.
protected void	reverseVisit(Visitor<V> visitor, int pos, CList<V> last)
int	size() Get the number of elements in the collection.
CList<V>	tail() Get the rest of the list after the head.
void	toCollection(Collection<V> collection) Copy elements in list to collection in order.
protected void	toCollection(Collection<V> collection, int pos)
boolean	visit(ConditionalVisitor<V> visitor) Visit each element in order until visit returns false.
protected boolean	visit(ConditionalVisitor<V> visitor, int pos)
void	visit(Visitor<V> visitor) Visit each element in order.
protected void	visit(Visitor<V> visitor, int pos)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CodedList

protected CodedList(V element,
         CList<V> list)

Constructor. Can be called by NIL and with a NIL list argument. This constructor implements cons.

Parameters:

element -

list -

CodedList

protected CodedList(V element,
         CodedList<V> list,
         int pos)

CodedList

protected CodedList(CodedList<V> other)

Method Detail

isEmpty

public boolean isEmpty()

Description copied from interface: Access

Test if empty. isEmpty() is guaranteed to be an O(1) operation; it should always be used in preference to size() == 0, as the latter may have cost up to O(n);

Specified by:

isEmpty in interface Access<V>

Returns:

true if the collection contains no elements; otherwise false

size

public int size()

Description copied from interface: Access

Get the number of elements in the collection. Depending on the collection, size() may have cost O(1), O(log(n) up to O(n).

Specified by:

size in interface Access<V>

Returns:

number of elements

contains

public boolean contains(V element)

Description copied from interface: CList

Test for element.

Specified by:

contains in interface Access<V>

Specified by:

contains in interface CList<V>

Returns:

true if list contains element; otherwise, false

contains

protected boolean contains(V element,
               int pos)

cons

public CList<V> cons(V element)

Description copied from interface: CList

Add an element to the head of the list.

Specified by:

cons in interface CList<V>

Returns:

new list

head

public V head()

Description copied from interface: CList

Get the head of the list.

Specified by:

head in interface CList<V>

Returns:

element

tail

public CList<V> tail()

Description copied from interface: CList

Get the rest of the list after the head. Note that getFirst/getRest are not the most efficient way to traverse the list elements.

Specified by:

tail in interface CList<V>

Returns:

list

See Also:

CList.iterator()

visit

protected void visit(Visitor<V> visitor,
         int pos)

visit

protected boolean visit(ConditionalVisitor<V> visitor,
            int pos)

reverseVisit

protected void reverseVisit(Visitor<V> visitor,
                int pos,
                CList<V> last)

reverseVisit

protected boolean reverseVisit(ConditionalVisitor<V> visitor,
                   int pos,
                   CList<V> last)

visit

public void visit(Visitor<V> visitor)

Description copied from interface: CList

Visit each element in order.

Specified by:

visit in interface Access<V>

Specified by:

visit in interface CList<V>

visit

public boolean visit(ConditionalVisitor<V> visitor)

Description copied from interface: CList

Visit each element in order until visit returns false.

If the list is empty, returns true.

Specified by:

visit in interface Access<V>

Specified by:

visit in interface CList<V>

Returns:

false if any call to visit returned false; otherwise true

reverseVisit

public void reverseVisit(Visitor<V> visitor)

Description copied from interface: Access

Visit all elements in reverse order.

Specified by:

reverseVisit in interface Access<V>

reverseVisit

public boolean reverseVisit(ConditionalVisitor<V> visitor)

Description copied from interface: Access

Visit all elements in reverse order until visitor.visit() returns true;

Specified by:

reverseVisit in interface Access<V>

Returns:

true if any call to visitor.visit() returned true; otherwise false

toCollection

protected void toCollection(Collection<V> collection,
                int pos)

toCollection

public void toCollection(Collection<V> collection)

Description copied from interface: CList

Copy elements in list to collection in order.

Specified by:

toCollection in interface CList<V>

iterator

public Iterator<V> iterator()

Description copied from interface: CList

Iterate through the elements in the list. This is the most efficient way to traverse the list elements.

Specified by:

iterator in interface Iterable<V>

Specified by:

iterator in interface Access<V>

Specified by:

iterator in interface CList<V>

Returns:

element iterator

reverseIterator

public Iterator<V> reverseIterator()

Description copied from interface: Access

Get the elements in reverse order.

Specified by:

reverseIterator in interface Access<V>

Returns:

element iterator