Package convex.core.data

Class ASequence<T extends ACell>

java.lang.Object

convex.core.data.AObject

convex.core.data.ACell

convex.core.data.ACountable<T>

convex.core.data.ADataStructure<T>

convex.core.data.ACollection<T>

convex.core.data.ASequence<T>

Type Parameters:

T - Type of list elements

All Implemented Interfaces:

IAssociative<CVMLong,T>, IValidated, IWriteable, Iterable<T>, Collection<T>, List<T>, SequencedCollection<T>

Direct Known Subclasses:

AList, AVector

public abstract class ASequence<T extends ACell>
extends ACollection<T>
implements List<T>, IAssociative<CVMLong,T>

Abstract base class for concrete sequential data structure (immutable persistent lists and vectors etc.)

Field Summary

Fields inherited from class convex.core.data.ADataStructure

count

Fields inherited from class convex.core.data.ACell

cachedRef, memorySize

Fields inherited from class convex.core.data.AObject

encoding

Constructor Summary

Constructors

Constructor	Description
ASequence(long count)

Method Summary

Modifier and Type	Method	Description
final void	add(int index, T element)
final boolean	addAll(int index, Collection<? extends T> c)
abstract ASequence<T>	assoc(long i, T value)	Updates a value at the given position in the sequence.
ASequence<T>	assoc(ACell key, ACell value)	Associates a key with a value in this associative data structure.
protected boolean	checkRange(long start, long end)	Checks if an index range is valid for this sequence
abstract ASequence<T>	concat(ASequence<? extends T> vals)	Concatenates the elements from another sequence to the end of this sequence.
abstract ASequence<T>	conj(ACell value)	Adds an element to the sequence in the natural position
abstract AList<T>	cons(T x)	Prepends an element to this sequence, returning a list.
boolean	contains(Object o)
boolean	containsKey(ACell key)	Checks if the data structure contains the specified key
abstract ASequence<T>	empty()	Returns an empty instance of the same Type as this data structure.
<R extends ACell> ASequence<R>	flatMap(Function<? super T,? extends ASequence<R>> mapper)
abstract void	forEach(Consumer<? super T> action)
T	get(int index)	Gets the element at the specified index in this sequence.
abstract T	get(long index)	Gets the element at the specified element index in this value
T	get(ACell key)	Gets the element at the specified key
ACell	get(ACell key, ACell notFound)	Get the value associated with a given key.
abstract Ref<T>	getElementRef(long index)	Gets the element Ref at the specified index
final boolean	isCVMValue()	Sequences are always valid CVM values
protected abstract ListIterator<T>	listIterator(long l)	Gets the ListIterator for a long position
abstract long	longIndexOf(Object value)	Gets the first long index at which the specified value appears in the the sequence.
abstract long	longLastIndexOf(Object value)	Gets the last long index at which the specified value appears in the the sequence.
abstract <R extends ACell> ASequence<R>	map(Function<? super T,? extends R> mapper)	Maps a function over a collection, applying it to each element in turn.
abstract ASequence<T>	next()	Gets the sequence of all elements after the first, or null if no elements remain after the first (i.e.
final T	remove(int index)
abstract ASequence<T>	reverse()	Reverses a sequence, converting Lists to Vectors and vice versa
T	set(int index, T element)
abstract ASequence<T>	slice(long start, long end)	Produces a slice of this sequence, beginning with the specified start index and of the given length.
Spliterator<T>	spliterator()
Spliterator<T>	spliterator(long start, long end)	Gets a Spliterator for the given range of this sequence
final List<T>	subList(int fromIndex, int toIndex)
abstract AVector<T>	subVector(long start, long length)	Gets a vector containing the specified subset of this sequence, or null if range is invalid
ACell[]	toCellArray()	Converts this sequence to a new Cell array
abstract void	visitElementRefs(Consumer<Ref<T>> f)	Visits all elements in this sequence, calling the specified consumer for each.

Methods inherited from class convex.core.data.ACollection

add, addAll, clear, containsAll, copyToArray, encode, getType, iterator, remove, removeAll, retainAll, toArray, toArray, toVector

Methods inherited from class convex.core.data.ADataStructure

checkIndex, conjAll, count, isDataValue, isEmpty, size, toCVMString

Methods inherited from class convex.core.data.ACountable

slice

Methods inherited from class convex.core.data.ACell

attachMemorySize, attachRef, cachedEncoding, cachedHash, calcMemorySize, createEncoding, createRef, encodeRaw, equals, equals, genericEquals, getCanonical, getChildRefs, getEncoding, getEncodingLength, getHash, getMemorySize, getMemorySize, getRef, getRef, getRefCount, getTag, hashCode, isCanonical, isEmbedded, toCanonical, toString, updateRefs, validate, validateCell

Methods inherited from class convex.core.data.AObject

attachEncoding, print, print, print

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface convex.core.data.IWriteable

estimatedEncodingSize

Methods inherited from interface java.util.List

add, addAll, addFirst, addLast, clear, containsAll, equals, getFirst, getLast, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, removeAll, removeFirst, removeLast, replaceAll, retainAll, reversed, size, sort, toArray, toArray

Constructor Details

ASequence

public ASequence(long count)

Method Details

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<T extends ACell>

Specified by:

contains in interface List<T extends ACell>

Specified by:

contains in class ACollection<T extends ACell>

longIndexOf

public abstract long longIndexOf(Object value)

Gets the first long index at which the specified value appears in the the sequence. Similar to Java's standard List.indexOf(...) but supports long indexes.

Parameters:

value - Any value which could appear as an element of the sequence.

Returns:

Index of the value, or -1 if not found.

longLastIndexOf

public abstract long longLastIndexOf(Object value)

Gets the last long index at which the specified value appears in the the sequence. Similar to Java's standard List.lastIndexOf(...) but supports long indexes.

Parameters:

value - Any value which could appear as an element of the sequence.

Returns:

Index of the value, or -1 if not found.

map

public abstract <R extends ACell> ASequence<R> map(Function<? super T,? extends R> mapper)

Description copied from class: ACollection

Maps a function over a collection, applying it to each element in turn.

Specified by:

map in class ACollection<T extends ACell>

Type Parameters:

R - Type of element in resulting collection

Parameters:

mapper - Function to map over collection

Returns:

Collection after function applied to each element

forEach

public abstract void forEach(Consumer<? super T> action)

Specified by:

forEach in interface Iterable<T extends ACell>

visitElementRefs

public abstract void visitElementRefs(Consumer<Ref<T>> f)

Visits all elements in this sequence, calling the specified consumer for each.

Parameters:

f - Function to call for each element

flatMap

public <R extends ACell> ASequence<R> flatMap(Function<? super T,? extends ASequence<R>> mapper)

concat

public abstract ASequence<T> concat(ASequence<? extends T> vals)

Concatenates the elements from another sequence to the end of this sequence. Potentially O(n) in size of resulting sequence

Parameters:

vals - A sequence of values to concatenate.

Returns:

The concatenated sequence, of the same type as this sequence.

addAll

public final boolean addAll(int index,
 Collection<? extends T> c)

Specified by:

addAll in interface List<T extends ACell>

next

public abstract ASequence<T> next()

Gets the sequence of all elements after the first, or null if no elements remain after the first (i.e. count of 0 or 1)

Returns:

Sequence following the first element

empty

public abstract ASequence<T> empty()

Description copied from class: ADataStructure

Returns an empty instance of the same Type as this data structure.

Specified by:

empty in class ADataStructure<T extends ACell>

Returns:

An empty data structure

get

public T get(int index)

Gets the element at the specified index in this sequence. Behaves as if the index was considered as a long

Specified by:

get in interface List<T extends ACell>

Parameters:

index - Index of element to get

Returns:

Element at the specified index

isCVMValue

public final boolean isCVMValue()

Sequences are always valid CVM values

Specified by:

isCVMValue in class ACell

Returns:

true if the object is a CVM Value, false otherwise

get

public abstract T get(long index)

Description copied from class: ACountable

Gets the element at the specified element index in this value

Specified by:

get in class ACountable<T extends ACell>

Parameters:

index - Index of element to get

Returns:

Element at the specified index

get

public T get(ACell key)

Gets the element at the specified key

Specified by:

get in class ADataStructure<T extends ACell>

Parameters:

key - Key of element to get

Returns:

The value at the specified index, or null if not valid

get

public ACell get(ACell key,
 ACell notFound)

Description copied from class: ADataStructure

Get the value associated with a given key.

Specified by:

get in class ADataStructure<T extends ACell>

Parameters:

key - Key to look up in data structure

notFound - Value to return if key is not found

Returns:

Value from collection, or notFound value if not found

containsKey

public boolean containsKey(ACell key)

Description copied from class: ADataStructure

Checks if the data structure contains the specified key

Specified by:

containsKey in class ADataStructure<T extends ACell>

Parameters:

key - Associative key to look up

Returns:

true if the data structure contains the key, false otherwise

getElementRef

public abstract Ref<T> getElementRef(long index)

Gets the element Ref at the specified index

Specified by:

getElementRef in class ACountable<T extends ACell>

Parameters:

index - Index of element to get

Returns:

Ref to element at specified index

set

public T set(int index,
 T element)

Specified by:

set in interface List<T extends ACell>

assoc

public ASequence<T> assoc(ACell key,
 ACell value)

Description copied from class: ADataStructure

Associates a key with a value in this associative data structure. May return null if the Key or Value is incompatible with the data structure.

Specified by:

assoc in class ADataStructure<T extends ACell>

Parameters:

key - Associative key

value - Value to associate with key

Returns:

Updates data structure, or null if data types are invalid

assoc

public abstract ASequence<T> assoc(long i,
 T value)

Updates a value at the given position in the sequence.

Parameters:

i - Index of element to update

value - New element value

Returns:

Updated sequence, or null if index is out of range

checkRange

protected boolean checkRange(long start,
 long end)

Checks if an index range is valid for this sequence

Parameters:

start -

length -

add

public final void add(int index,
 T element)

Specified by:

add in interface List<T extends ACell>

remove

public final T remove(int index)

Specified by:

remove in interface List<T extends ACell>

toCellArray

public ACell[] toCellArray()

Converts this sequence to a new Cell array

Overrides:

toCellArray in class ACollection<T extends ACell>

Returns:

A new cell array containing the elements of this sequence

conj

public abstract ASequence<T> conj(ACell value)

Adds an element to the sequence in the natural position

Specified by:

conj in class ACollection<T extends ACell>

Parameters:

value - Value to add

Returns:

Updated sequence, or null if value is invalid

slice

public abstract ASequence<T> slice(long start,
 long end)

Produces a slice of this sequence, beginning with the specified start index and of the given length. The start and end must be contained within this sequence. Will return the same sequence if the start is zero and the length matches this sequence.

Specified by:

slice in class ACountable<T extends ACell>

Parameters:

start - Index of the start element

end - End index(exclusive)

Returns:

A sequence representing the requested slice.

cons

public abstract AList<T> cons(T x)

Prepends an element to this sequence, returning a list.

Parameters:

x - Any new element value

Returns:

A list starting with the new element.

subVector

public abstract AVector<T> subVector(long start,
 long length)

Gets a vector containing the specified subset of this sequence, or null if range is invalid

Parameters:

start - Start index of sub vector

length - Length of sub vector to produce

Returns:

Sub-vector of this sequence

subList

public final List<T> subList(int fromIndex,
 int toIndex)

Specified by:

subList in interface List<T extends ACell>

listIterator

protected abstract ListIterator<T> listIterator(long l)

Gets the ListIterator for a long position

Parameters:

l -

Returns:

ListIterator instance.

spliterator

public Spliterator<T> spliterator()

Specified by:

spliterator in interface Collection<T extends ACell>

Specified by:

spliterator in interface Iterable<T extends ACell>

Specified by:

spliterator in interface List<T extends ACell>

spliterator

public Spliterator<T> spliterator(long start,
 long end)

Gets a Spliterator for the given range of this sequence

Parameters:

start - Start position (inclusive)

end - End position (exclusive)

Returns:

Spliterator instance

reverse

public abstract ASequence<T> reverse()

Reverses a sequence, converting Lists to Vectors and vice versa

Returns:

Reversed sequence