io.lacuna.bifurcan

Class SortedSet<V>

java.lang.Object

io.lacuna.bifurcan.SortedSet<V>

All Implemented Interfaces:

ICollection<ISet<V>,V>, ISet<V>, ISortedSet<V>, Iterable<V>, Predicate<V>

public class SortedSet<V>
extends Object
implements ISortedSet<V>

Constructor Summary

Constructors

Constructor and Description
SortedSet()

Method Summary

Modifier and Type	Method and Description
SortedSet<V>	add(V value)
V	ceil(V val)
ISet<V>	clone()
Comparator<V>	comparator()
boolean	contains(V value)
IList<V>	elements()
boolean	equals(Object obj)
V	floor(V val)
SortedSet<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()
OptionalLong	indexOf(V element)
SortedSet<V>	linear() This returns a data structure which is linear, or temporarily mutable.
V	nth(long idx)
SortedSet<V>	remove(V value)
long	size()
SortedSet<V>	slice(V min, V max)
String	toString()
BiPredicate<V,V>	valueEquality()
ToLongFunction<V>	valueHash()
<U> SortedMap<V,U>	zip(Function<V,U> f)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.lacuna.bifurcan.ISortedSet

difference, first, intersection, last, union

Methods inherited from interface io.lacuna.bifurcan.ISet

containsAll, containsAll, containsAny, containsAny, isLinear, iterator, split, spliterator, stream, test, toArray, toArray, toSet

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

SortedSet

public SortedSet()

Method Detail

comparator

public Comparator<V> comparator()

Specified by:

comparator in interface ISortedSet<V>

floor

public V floor(V val)

Specified by:

floor in interface ISortedSet<V>

Returns:

the entry whose key is either equal to key, or just below it. If key is less than the minimum value in the map, returns null.

ceil

public V ceil(V val)

Specified by:

ceil in interface ISortedSet<V>

Returns:

the entry whose key is either equal to key, or just above it. If key is greater than the maximum value in the map, returns null.

slice

public SortedSet<V> slice(V min,
                          V max)

Specified by:

slice in interface ISortedSet<V>

Parameters:

min - the inclusive minimum key value

max - the inclusive maximum key value

Returns:

a map representing all entries within [min, max]

add

public SortedSet<V> add(V value)

Specified by:

add in interface ISet<V>

Specified by:

add in interface ISortedSet<V>

Returns:

the set, containing value

remove

public SortedSet<V> remove(V value)

Specified by:

remove in interface ISet<V>

Specified by:

remove in interface ISortedSet<V>

Returns:

the set, without value

zip

public <U> SortedMap<V,U> zip(Function<V,U> f)

Specified by:

zip in interface ISet<V>

Returns:

a map which has a corresponding value, computed by f, for each element in the set

valueHash

public ToLongFunction<V> valueHash()

Specified by:

valueHash in interface ISet<V>

Returns:

the hash function used by the set

valueEquality

public BiPredicate<V,V> valueEquality()

Specified by:

valueEquality in interface ISet<V>

Returns:

the equality semantics used by the set

contains

public boolean contains(V value)

Specified by:

contains in interface ISet<V>

Returns:

true, if the set contains value

indexOf

public OptionalLong indexOf(V element)

Specified by:

indexOf in interface ISet<V>

Returns:

the position of element in the collection, if it's present

size

public long size()

Specified by:

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

Returns:

the number of elements in the collection

nth

public V nth(long idx)

Specified by:

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

Returns:

the element at idx

elements

public IList<V> elements()

Specified by:

elements in interface ISet<V>

Returns:

a list containing all the elements in the set

forked

public SortedSet<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>

Specified by:

forked in interface ISortedSet<V>

Returns:

a forked form of the data structure

linear

public SortedSet<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>

Specified by:

linear in interface ISortedSet<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 ISet<V> clone()

Specified by:

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

Overrides:

clone in class Object

Returns:

a cloned copy of the collection