io.lacuna.bifurcan.diffs

Class DiffList<V>

java.lang.Object

io.lacuna.bifurcan.IList.Mixin<V>

io.lacuna.bifurcan.diffs.DiffList<V>

All Implemented Interfaces:

ICollection<IList<V>,V>, IDiff<IList<V>>, IDiffList<V>, IList<V>, Iterable<V>

public class DiffList<V>
extends IList.Mixin<V>
implements IDiffList<V>

Nested Class Summary

Nested classes/interfaces inherited from interface io.lacuna.bifurcan.IDiffList

IDiffList.Durable<V>, IDiffList.Slice

Nested classes/interfaces inherited from interface io.lacuna.bifurcan.IList

IList.Mixin<V>

Field Summary

Fields inherited from class io.lacuna.bifurcan.IList.Mixin

hash

Constructor Summary

Constructors

Constructor and Description
DiffList(IList<V> underlying)

Method Summary

Modifier and Type	Method and Description
IList<V>	addFirst(V value)
IList<V>	addLast(V value)
DiffList<V>	clone()
DiffList<V>	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()
DiffList<V>	linear() This returns a data structure which is linear, or temporarily mutable.
IList<V>	prefix()
IDiffList<V>	rebase(IList<V> newUnderlying) Returns a new diff, which is rebased atop the new underlying collection.
IList<V>	removeFirst()
IList<V>	removeLast()
IList<V>	set(long idx, V value)
IDiffList.Slice	slice()
IList<V>	slice(long start, long end)
IList<V>	suffix()
IList<V>	underlying() The underlying collection

Methods inherited from class io.lacuna.bifurcan.IList.Mixin

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.lacuna.bifurcan.IDiffList

concat, iterator, nth, size

Methods inherited from interface io.lacuna.bifurcan.IList

diff, equals, first, iterator, last, save, split, spliterator, stream, toArray, toArray, toList, update

Methods inherited from interface io.lacuna.bifurcan.ICollection

nth

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

DiffList

public DiffList(IList<V> underlying)

Method Detail

underlying

public IList<V> underlying()

Description copied from interface: IDiff

The underlying collection

Specified by:

underlying in interface IDiff<IList<V>>

Specified by:

underlying in interface IDiffList<V>

slice

public IDiffList.Slice slice()

Specified by:

slice in interface IDiffList<V>

prefix

public IList<V> prefix()

Specified by:

prefix in interface IDiffList<V>

suffix

public IList<V> suffix()

Specified by:

suffix in interface IDiffList<V>

rebase

public IDiffList<V> rebase(IList<V> newUnderlying)

Description copied from interface: IDiff

Returns a new diff, which is rebased atop the new underlying collection. The returned diff may not reflect any changes which cannot be applied to the new collection (removing an element which isn't present in the new collection, for instance), and so a.rebase(b).rebase(c) is not necessarily equivalent to a.rebase(c) .

Specified by:

rebase in interface IDiff<IList<V>>

Specified by:

rebase in interface IDiffList<V>

slice

public IList<V> slice(long start,
                      long end)

Specified by:

slice in interface IList<V>

Parameters:

start - the inclusive start of the range

end - the exclusive end of the range

Returns:

a sub-range of the list within [start, end), which is linear if this is linear

addLast

public IList<V> addLast(V value)

Specified by:

addLast in interface IList<V>

Returns:

a new list, with value appended

addFirst

public IList<V> addFirst(V value)

Specified by:

addFirst in interface IList<V>

Returns:

a new list, with value prepended

removeLast

public IList<V> removeLast()

Specified by:

removeLast in interface IList<V>

Returns:

a new list with the last value removed, or the same list if already empty

removeFirst

public IList<V> removeFirst()

Specified by:

removeFirst in interface IList<V>

Returns:

a new list with the first value removed, or the same value if already empty

set

public IList<V> set(long idx,
                    V value)

Specified by:

set in interface IList<V>

Returns:

a new list, with the element at idx overwritten with value. If idx is equal to ICollection.size(), the value is appended.

isLinear

public boolean isLinear()

Specified by:

isLinear in interface ICollection<IList<V>,V>

Specified by:

isLinear in interface IList<V>

Returns:

true, if the list is linear

forked

public DiffList<V> forked()

Description copied from interface: ICollection

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.

Specified by:

forked in interface ICollection<IList<V>,V>

Specified by:

forked in interface IList<V>

Returns:

a forked form of the data structure

linear

public DiffList<V> linear()

Description copied from interface: ICollection

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 ICollection.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.

Specified by:

linear in interface ICollection<IList<V>,V>

Specified by:

linear in interface IList<V>

Returns:

a linear form of this data structure

clone

public DiffList<V> clone()

Specified by:

clone in interface ICollection<IList<V>,V>

Specified by:

clone in interface IDiffList<V>

Overrides:

clone in class IList.Mixin<V>

Returns:

a cloned copy of the collection