com.ideaheap.barelyfunctional.data

Class BfSets

java.lang.Object

com.ideaheap.barelyfunctional.data.BfSets

public class BfSets
extends Object

An immutable set library. Provides convenience functions for dealing with sets.

Constructor Summary

Constructors

Constructor and Description
BfSets()

Method Summary

Modifier and Type	Method and Description
static <T> Set<T>	assoc(Set<T> set, T... vals) Add the values specified to the set.
static <T> Set<T>	dissoc(Set<T> set, T... vals) Remove the values specified from the set.
static <T> Set<T>	intersection(Set<T>... sets) Create a set that is the intersection of a number of other sets.
static <T> Set<T>	not(Set<T> set, Set<T>... removals) Create a set that is the given set minus any of the elements specified.
static <T> Set<T>	set(T... values) Create a set with the values specified
static <T> Set<T>	union(Set<T>... sets) Create a set that is the union of a number of other sets.
static <T> Set<T>	xor(Set<T>... sets) Create a set with the elements that are unique in each of the sets given.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BfSets

public BfSets()

Method Detail

set

public static <T> Set<T> set(T... values)

Create a set with the values specified

Parameters:

values - the values to use.

Returns:

A set with the values specified.

assoc

public static <T> Set<T> assoc(Set<T> set,
                               T... vals)

Add the values specified to the set. Dedup any duplicates.

Parameters:

set - the set to start with.

vals - the values to add.

Returns:

A set with vals added to it.

dissoc

public static <T> Set<T> dissoc(Set<T> set,
                                T... vals)

Remove the values specified from the set. This does not care if the value was there to start with.

Parameters:

set - The set to remove values from

vals - The values to remove

Returns:

A set minus the values mentioned.

union

public static <T> Set<T> union(Set<T>... sets)

Create a set that is the union of a number of other sets. This is the set of elements from all sets.

Parameters:

sets - The sets to union.

Returns:

A set that is the union of the sets given.

intersection

public static <T> Set<T> intersection(Set<T>... sets)

Create a set that is the intersection of a number of other sets. An intersection are the values that are in all sets.

Parameters:

sets - The sets to intersect.

Returns:

A set with the values that were found in every set.

xor

public static <T> Set<T> xor(Set<T>... sets)

Create a set with the elements that are unique in each of the sets given.

Parameters:

sets - The sets to look for unique elements

Returns:

The set of elements that were only found once in any set.

not

public static <T> Set<T> not(Set<T> set,
                             Set<T>... removals)

Create a set that is the given set minus any of the elements specified. This does not care if the elements were in there or not.

Parameters:

set - the set to start from

removals - the elements to remove from the set.

Returns:

The set minus the elements set for removal.