io.lacuna.bifurcan.diffs

Class DiffSet<V>

java.lang.Object

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

All Implemented Interfaces:

ICollection<ISet<V>,V>, IDiff<IMap<V,Void>,IEntry<V,Void>>, IDiffSet<V>, ISet<V>, Iterable<V>, Predicate<V>

public class DiffSet<V>
extends Object
implements IDiffSet<V>

Constructor Summary

Constructors

Constructor and Description
DiffSet(IMap<V,?> underlying)
DiffSet(ISet<V> underlying)

Method Summary

Modifier and Type	Method and Description
ISet<V>	add(V value)
DiffSet<V>	clone()
IDiffMap<V,Void>	diffMap()
boolean	equals(Object obj)
ISet<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.
int	hashCode()
boolean	isLinear()
ISet<V>	linear() This returns a data structure which is linear, or temporarily mutable.
ISet<V>	remove(V value)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.lacuna.bifurcan.IDiffSet

elements, indexOf, nth, size, underlying, valueEquality, valueHash

Methods inherited from interface io.lacuna.bifurcan.ISet

contains, containsAll, containsAll, containsAny, containsAny, difference, intersection, iterator, split, spliterator, stream, test, toArray, toArray, toSet, union, zip

Methods inherited from interface io.lacuna.bifurcan.ICollection

nth, save

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

Constructor Detail

DiffSet

public DiffSet(IMap<V,?> underlying)

DiffSet

public DiffSet(ISet<V> underlying)

Method Detail

diffMap

public IDiffMap<V,Void> diffMap()

Specified by:

diffMap in interface IDiffSet<V>

add

public ISet<V> add(V value)

Specified by:

add in interface ISet<V>

Returns:

the set, containing value

remove

public ISet<V> remove(V value)

Specified by:

remove in interface ISet<V>

Returns:

the set, without value

isLinear

public boolean isLinear()

Specified by:

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

Specified by:

isLinear in interface ISet<V>

Returns:

true, if the set is linear

forked

public ISet<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<ISet<V>,V>

Specified by:

forked in interface ISet<V>

Returns:

a forked form of the data structure

linear

public ISet<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<ISet<V>,V>

Specified by:

linear in interface ISet<V>

Returns:

a linear form of this data structure

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

clone

public DiffSet<V> clone()

Specified by:

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

Specified by:

clone in interface IDiffSet<V>

Overrides:

clone in class Object

Returns:

a cloned copy of the collection