io.lacuna.bifurcan

Class Set<V>

java.lang.Object

io.lacuna.bifurcan.Set<V>

All Implemented Interfaces:

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

public class Set<V>
extends Object
implements ISet<V>, Cloneable

A set which builds atop Map, and shares the same performance characteristics.

Field Summary

Fields

Modifier and Type	Field and Description
static Set	EMPTY

Constructor Summary

Constructors

Constructor and Description
Set()
Set(ToLongFunction<V> hashFn, BiPredicate<V,V> equalsFn)

Method Summary

Modifier and Type	Method and Description
Set<V>	add(V value)
Set<V>	add(V value, Object editor)
Set<V>	clone()
boolean	contains(V value)
Set<V>	difference(ISet<V> s)
boolean	equals(Object obj)
Set<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.
static <V> Set<V>	from(ISet<V> s)
static <V> Set<V>	from(Iterable<V> iterable)
static <V> Set<V>	from(Iterator<V> iterator)
int	hashCode()
OptionalLong	indexOf(V element)
Set<V>	intersection(ISet<V> s)
boolean	isLinear()
Iterator<V>	iterator()
Set<V>	linear() This returns a data structure which is linear, or temporarily mutable.
V	nth(long idx)
static <V> Set<V>	of(V... elements)
Set<V>	remove(V value)
Set<V>	remove(V value, Object editor)
long	size()
List<Set<V>>	split(int parts) Splits the collection into roughly even pieces, for parallel processing.
String	toString()
Set<V>	union(ISet<V> s)
BiPredicate<V,V>	valueEquality()
ToLongFunction<V>	valueHash()
<U> Map<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.ISet

containsAll, containsAll, containsAny, containsAny, elements, 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

Field Detail

EMPTY

public static final Set EMPTY

Constructor Detail

Set

public Set()

Set

public Set(ToLongFunction<V> hashFn,
           BiPredicate<V,V> equalsFn)

Parameters:

hashFn - the hash function used by the set

equalsFn - the equality semantics used by the set

Method Detail

from

public static <V> Set<V> from(ISet<V> s)

Parameters:

s - a set

Returns:

an equivalent set, with the same equality semantics

from

public static <V> Set<V> from(Iterator<V> iterator)

Parameters:

iterator - an iterator

Returns:

a set containing the remaining values in the iterator

from

public static <V> Set<V> from(Iterable<V> iterable)

Parameters:

iterable - an Iterable object

Returns:

a set containing the values in the iterator

of

public static <V> Set<V> of(V... elements)

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

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

size

public long size()

Specified by:

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

Returns:

the number of elements in the collection

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

nth

public V nth(long idx)

Specified by:

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

Returns:

the element at idx

add

public Set<V> add(V value)

Specified by:

add in interface ISet<V>

Returns:

the set, containing value

add

public Set<V> add(V value,
                  Object editor)

remove

public Set<V> remove(V value)

Specified by:

remove in interface ISet<V>

Returns:

the set, without value

remove

public Set<V> remove(V value,
                     Object editor)

split

public List<Set<V>> split(int parts)

Description copied from interface: ICollection

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.

Specified by:

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

Specified by:

split in interface ISet<V>

Parameters:

parts - the target number of pieces

Returns:

a list containing subsets of the collection.

iterator

public Iterator<V> iterator()

Specified by:

iterator in interface ISet<V>

Specified by:

iterator in interface Iterable<V>

Returns:

an iterator representing the elements of the set

zip

public <U> Map<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

union

public Set<V> union(ISet<V> s)

Specified by:

union in interface ISet<V>

Returns:

a new set, representing the union with set

difference

public Set<V> difference(ISet<V> s)

Specified by:

difference in interface ISet<V>

Returns:

a new set, representing the difference with set

intersection

public Set<V> intersection(ISet<V> s)

Specified by:

intersection in interface ISet<V>

Returns:

a new set, representing the intersection with set

forked

public Set<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 Set<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 Set<V> clone()

Specified by:

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

Overrides:

clone in class Object

Returns:

a cloned copy of the collection