io.lacuna.bifurcan

Interface ISortedSet<V>

All Superinterfaces:

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

All Known Implementing Classes:

IntSet, SortedSet

public interface ISortedSet<V>
extends ISet<V>

Method Summary

Modifier and Type	Method and Description
ISortedSet<V>	add(V value)
default V	ceil(V val)
Comparator<V>	comparator()
default ISortedSet<V>	difference(ISet<V> s)
default V	first()
V	floor(V val)
ISortedSet<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.
default ISortedSet<V>	intersection(ISet<V> s)
default V	last()
ISortedSet<V>	linear() This returns a data structure which is linear, or temporarily mutable.
ISortedSet<V>	remove(V value)
ISortedSet<V>	slice(V min, V max)
default ISortedSet<V>	union(ISet<V> s)

Methods inherited from interface io.lacuna.bifurcan.ISet

contains, containsAll, containsAll, containsAny, containsAny, elements, indexOf, isLinear, iterator, split, spliterator, stream, test, toArray, toArray, toSet, valueEquality, valueHash, zip

Methods inherited from interface io.lacuna.bifurcan.ICollection

clone, nth, nth, save, size

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

Method Detail

comparator

Comparator<V> comparator()

floor

V floor(V val)

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

default V ceil(V val)

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

ISortedSet<V> slice(V min,
                    V max)

Parameters:

min - the inclusive minimum key value

max - the inclusive maximum key value

Returns:

a map representing all entries within [min, max]

add

ISortedSet<V> add(V value)

Specified by:

add in interface ISet<V>

Returns:

the set, containing value

remove

ISortedSet<V> remove(V value)

Specified by:

remove in interface ISet<V>

Returns:

the set, without value

union

default ISortedSet<V> union(ISet<V> s)

Specified by:

union in interface ISet<V>

Returns:

a new set, representing the union with set

difference

default ISortedSet<V> difference(ISet<V> s)

Specified by:

difference in interface ISet<V>

Returns:

a new set, representing the difference with set

intersection

default ISortedSet<V> intersection(ISet<V> s)

Specified by:

intersection in interface ISet<V>

Returns:

a new set, representing the intersection with set

forked

ISortedSet<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

ISortedSet<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

first

default V first()

last

default V last()