io.lacuna.bifurcan

Interface ICollection<C,V>

All Superinterfaces:

Iterable<V>

All Known Subinterfaces:

IDiffList<V>, IDiffMap<K,V>, IDiffSet<V>, IDiffSortedMap<K,V>, IGraph<V,E>, IList<V>, IMap<K,V>, ISet<V>, ISortedMap<K,V>, ISortedSet<V>

All Known Implementing Classes:

ConcatList, DiffList, DiffMap, DiffSet, DirectedAcyclicGraph, DirectedGraph, DurableList, DurableMap, FloatMap, Graph, IntMap, IntSet, LinearList, LinearMap, LinearSet, List, Map, Set, SortedMap, SortedSet

public interface ICollection<C,V>
extends Iterable<V>

Method Summary

Modifier and Type	Method and Description
C	clone()
C	forked() This returns a data structure which is forked, which is equivalent to Clojure's persistent data structures, also sometimes called functional or immutable.
boolean	isLinear()
C	linear() This returns a data structure which is linear, or temporarily mutable.
V	nth(long idx)
default V	nth(long idx, V defaultValue)
C	save(IDurableEncoding encoding, Path directory)
long	size()
IList<? extends C>	split(int parts) Splits the collection into roughly even pieces, for parallel processing.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

linear

C linear()

This returns a data structure which is linear, or temporarily mutable. The term "linear", as used here, does not completely align with the formal definition of linear types as used in type theory. It is meant to describe the linear dataflow of the method calls, and as a converse to "forked" data structures.

If forked() is called on a linear collection, all references to that linear collection should be discarded.

If the data structure is already linear, it will simply return itself.

Returns:

a linear form of this data structure

isLinear

boolean isLinear()

Returns:

true, if the collection is linear

forked

C forked()

This returns a data structure which is forked, which is equivalent to Clojure's persistent data structures, also sometimes called functional or immutable. This is called "forked" because it means that multiple functions can make divergent changes to the data structure without affecting each other.

If only a single function or scope uses the data structure, it can be left as a linear data structure, which can have significant performance benefits.

If the data structure is already forked, it will simply return itself.

Returns:

a forked form of the data structure

split

IList<? extends C> split(int parts)

Splits the collection into roughly even pieces, for parallel processing. Depending on the size and contents of the collection, this function may not return exactly parts subsets.

Parameters:

parts - the target number of pieces

Returns:

a list containing subsets of the collection.

size

long size()

Returns:

the number of elements in the collection

nth

V nth(long idx)

Returns:

the element at idx

Throws:

IndexOutOfBoundsException - when idx is not within [0, size-1]

nth

default V nth(long idx,
              V defaultValue)

Returns:

the element at idx, or defaultValue if it is not within [0, size-1]

clone

C clone()

Returns:

a cloned copy of the collection

save

C save(IDurableEncoding encoding,
       Path directory)