ch.claude_martin.enumbitset

Class EnumBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

java.lang.Object

ch.claude_martin.enumbitset.EnumBitSet<E>

Type Parameters:

E - Enum type that implements EnumBitSetHelper<E> .

All Implemented Interfaces:

DomainBitSet<E>, Serializable, Cloneable, Iterable<E>, Collection<E>

public final class EnumBitSet<E extends Enum<E> & EnumBitSetHelper<E>>
extends Object
implements DomainBitSet<E>, Collection<E>

This data structure allows managing enum constants in a mutable set with methods similar to EnumSet and BitSet. This holds a regular EnumSet, but adds more functions to use it as a BitSet. Note that the implementation of EnumSet works like a bit set but it does not share an interface with the type.

All information is hidden. But this class offers many more methods compared to EnumSet. Those extra methods are inspired by set theory so that set operations are much simpler to perform with the given methods. These methods are defined in the interface DomainBitSet.

Methods such as union(EnumBitSet), toEnumSet(), and complement() return a new and independent set. This allows a functional style of programming. However, this set is mutable. It can be altered using the interface of Collection ( add(Enum), remove(Object) etc.). This allows the classic imperative style of programming.

Sadly both BitSet and EnumSet are not implementations of some interface. Therefore this class can not share the interface of these other classes. Most methods are implemented here so this is in fact compatible in most cases.

This set is a DomainBitSet with a domain made of all enum elements of a given enum type.

This set is not thread-safe. You can use Collections.unmodifiableSet(Set), but will lose all methods not declared in Set.

See the package-info for naming conventions.

Author:

Copyright © 2014 Claude Martin

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
boolean	add(E e)
boolean	addAll(Collection<? extends E> c)
static <X extends Enum<X> & EnumBitSetHelper<X>> EnumBitSet<X>	allOf(Class<X> type) Creates an EnumBitSet containing all of the elements in the specified element type.
static <X extends Enum<X> & EnumBitSetHelper<X>> BigInteger	asBigInteger(EnumSet<X> set) Convert EnumSet to BitInteger.
static <X extends Enum<X> & EnumBitSetHelper<X>> BigInteger	asBigInteger(X... set) Convert VarArg/Array of enums to BitInteger.
static <X extends Enum<X> & EnumBitSetHelper<X>> BitSet	asBitSet(EnumSet<X> set) Creates a BitSet of a given set of enums.
static <X extends Enum<X> & EnumBitSetHelper<X>> BitSet	asBitSet(X... set) Creates a BitSet of a given set of enums.
static <X extends Enum<X> & EnumBitSetHelper<X>> EnumBitSet<X>	asEnumBitSet(BigInteger mask, Class<X> type) Creates set of enums from a bit set.
static <X extends Enum<X> & EnumBitSetHelper<X>> EnumBitSet<X>	asEnumBitSet(BitSet set, Class<X> type) Creates set of enums from a bit set.
static <X extends Enum<X> & EnumBitSetHelper<X>> EnumBitSet<X>	asEnumBitSet(Collection<X> collection, Class<X> type) Creates a new EnumBitSet from a given Collection.
static <X extends Enum<X> & EnumBitSetHelper<X>> EnumBitSet<X>	asEnumBitSet(EnumSet<X> set, Class<X> type) Creates a new EnumBitSet from a given BitSet.
static <X extends Enum<X> & EnumBitSetHelper<X>> EnumBitSet<X>	asEnumBitSet(long mask, Class<X> type) Creates set of enums from a long.
static <X extends Enum<X> & EnumBitSetHelper<X>> EnumSet<X>	asEnumSet(BigInteger mask, Class<X> type) Creates set of enums from a bit set.
static <X extends Enum<X> & EnumBitSetHelper<X>> EnumSet<X>	asEnumSet(BitSet bitset, Class<X> type) Creates set of enums from a BitSet.
static <X extends Enum<X> & EnumBitSetHelper<X>> EnumSet<X>	asEnumSet(long mask, Class<X> type) Creates set of enums from a 64 bit bit set.
static <X extends Enum<X> & EnumBitSetHelper<X>> EnumSet<X>	asEnumSet(X first, X... rest) Creates set of enums from at least one element.
static <X extends Enum<X> & EnumBitSetHelper<X>> long	asLong(EnumSet<X> set) Creates a 64 bit bitmask of a given set of enums.
static <X extends Enum<X> & EnumBitSetHelper<X>> long	asLong(X... set) Creates a 64 bit bit set of a given set of enums.
void	clear()
EnumBitSet<E>	clone() Returns a copy of this set.
EnumBitSet<E>	complement() Creates a new EnumBitSet with the same element type as this, initially containing all the elements of this type that are not contained in this set.
boolean	contains(Object o) Returns true if this set contains the specified element.
boolean	containsAll(Collection<?> c) Returns true if this set contains all of the elements in the specified collection.
<Y extends Enum<Y> & EnumBitSetHelper<Y>> Set<Pair<EnumBitSetHelper<?>,E,Y>>	cross(EnumBitSet<Y> set) The Cartesian product with another EnumBitSet.
boolean	domainContains(E object) Is the given enum constant an element of this set's domain?
boolean	equals(Object other) Compares the specified object with this domain bit set for equality.
void	forEach(Consumer<? super E> action)
boolean	getBit(int bitIndex) Returns the value of the bit with the specified index.
Domain<E>	getDomain() The Domain containing all elements of the enum type.
Class<E>	getEnumType() The enum type class that defines the available enum elements.
int	getEnumTypeSize() Amount of enum elements.
int	hashCode() Hash code of domain and elements.
EnumBitSet<E>	intersect(BigInteger mask) Returns a new EnumBitSet containing all elements that are in this and the given mask.
EnumBitSet<E>	intersect(BitSet set) Returns a new EnumBitSet containing all elements that are in this and the given set.
EnumBitSet<E>	intersect(EnumBitSet<E> set) Returns a new EnumBitSet containing all elements that are in this and the given set.
EnumBitSet<E>	intersect(EnumSet<E> set) Returns a new EnumBitSet containing all elements that are in this and the given set.
EnumBitSet<E>	intersect(Iterable<E> set) Returns a new EnumBitSet containing all elements that are in this and the given set.
EnumBitSet<E>	intersect(long mask) Returns a new EnumBitSet containing all elements that are in this and the given mask.
EnumBitSet<E>	intersectVarArgs(E... set) Returns a new EnumBitSet containing all elements that are in this and the given set.
boolean	isEmpty() Returns true if this set contains no elements.
Iterator<E>	iterator() Returns an iterator over elements of type T.
static <X extends Enum<X> & EnumBitSetHelper<X>> EnumBitSet<X>	just(X value) Returns a new EnumBitSet containing just one enum value.
<S extends Enum<S> & EnumBitSetHelper<S>> EnumBitSet<S>	map(Class<S> newEnumType) Returns a new set with elements of a given enum type, containing all elements of the other enum type.
<S extends Enum<S> & EnumBitSetHelper<S>> EnumBitSet<S>	map(Class<S> newEnumType, Function<E,S> mapper) Returns a new set with elements of a given enum type, containing all mapped elements.
<S> DomainBitSet<S>	map(Domain<S> newDomain, Function<E,S> mapper) Returns a new set with elements of a given domain, containing all mapped elements.
EnumBitSet<E>	minus(BigInteger mask) Returns a new EnumBitSet containing all elements that are in this, but not in the given mask.
EnumBitSet<E>	minus(BitSet set) Returns a new EnumBitSet containing all elements that are in this, but not in the given bit set.
EnumBitSet<E>	minus(EnumBitSet<E> set) Returns a new EnumBitSet containing all elements that are in this, but not in the given set.
EnumBitSet<E>	minus(EnumSet<E> set) Returns a new EnumBitSet containing all elements that are in this, but not in the given set.
EnumBitSet<E>	minus(Iterable<E> set) Returns a new EnumBitSet containing all elements that are in this, but not in the given set.
EnumBitSet<E>	minus(long mask) Returns a new EnumBitSet containing all elements that are in this, but not in the given mask.
EnumBitSet<E>	minusVarArgs(E... set) Returns a new EnumBitSet containing all elements that are in this, but not in the given set.
static <X extends Enum<X> & EnumBitSetHelper<X>> EnumBitSet<X>	noneOf(Class<X> type) Creates an EnumBitSet containing none of the elements in the specified element type.
static <X extends Enum<X> & EnumBitSetHelper<X>> EnumBitSet<X>	of(X first, X... more) Creates a new EnumBitSet containing at least one value.
boolean	ofEqualDomain(DomainBitSet<E> set) Compares the domains.
Stream<E>	parallelStream() Returns a possibly parallel Stream with this set as its source.
Iterable<EnumBitSet<E>>	powerset() The powerset, which is the set of all subsets.
static <X extends Enum<X> & EnumBitSetHelper<X>> EnumBitSet<X>	range(X from, X to) Creates an enum set initially containing all of the elements in the range defined by the two specified endpoints.
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
int	size() The number of elements in this set.
Spliterator<E>	spliterator() Creates a Spliterator over the elements in this collection.
Stream<E>	stream() Returns a sequential Stream with this collection as its source.
Object[]	toArray()
<T> T[]	toArray(T[] a)
BigInteger	toBigInteger() Returns a BigInteger that represents this set.
String	toBinaryString() Binary string representation of this set.
String	toBinaryString(int width) Binary string representation of this set.
BitSet	toBitSet() Returns a new BitSet that represents this set.
EnumSet<E>	toEnumSet() Copy of the underlying EnumSet.
long	toLong() Returns a long value that represents this set.
Set<E>	toSet() Copy of the underlying EnumSet.
String	toString() Returns a string representation of this set.
EnumBitSet<E>	union(BigInteger mask) Returns a new EnumBitSet containing all elements that are in this or the given mask.
EnumBitSet<E>	union(BitSet set) Returns a new EnumBitSet containing all elements that are in this or the given set.
EnumBitSet<E>	union(EnumBitSet<E> set) Returns a new EnumBitSet containing all elements that are in this or the given set.
EnumBitSet<E>	union(EnumSet<E> set) Returns a new EnumBitSet containing all elements that are in this or the given set.
EnumBitSet<E>	union(Iterable<E> set) The union of this set and a set represented by an iterable collection.
EnumBitSet<E>	union(long mask) Returns a new EnumBitSet containing all elements that are in this or the given mask.
EnumBitSet<E>	unionVarArgs(E... set) Returns a new EnumBitSet containing all elements that are in this or the given set.
Stream<Pair<Object,Integer,E>>	zipWithPosition() Returns a sequential stream with pairs of all elements of this set and their position in the domain.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ch.claude_martin.enumbitset.DomainBitSet

allOf, allOf, createMultiEnumBitSet, cross, cross, getElement, map, noneOf, noneOf, ofEqualElements, powerset, semijoin

Methods inherited from interface java.util.Collection

removeIf

Method Detail

allOf

public static <X extends Enum<X> & EnumBitSetHelper<X>> EnumBitSet<X> allOf(Class<X> type)

Creates an EnumBitSet containing all of the elements in the specified element type.

Type Parameters:

X - The enum type.

Parameters:

type - Enum type.

Returns:

EnumBitSet containing all elements.

See Also:

of(Enum, Enum...), noneOf(Class)

asBigInteger

public static <X extends Enum<X> & EnumBitSetHelper<X>> BigInteger asBigInteger(EnumSet<X> set)

Convert EnumSet to BitInteger.

Type Parameters:

X - Enum type of the elements.

Parameters:

set - A set of enum constants.

Returns:

A BigInteger that represents the given set as a bit mask.

asBigInteger

@SafeVarargs
public static <X extends Enum<X> & EnumBitSetHelper<X>> BigInteger asBigInteger(X... set)

Convert VarArg/Array of enums to BitInteger.

Type Parameters:

X - Enum type of the elements.

Parameters:

set - A set of enum constants.

Returns:

A BigInteger that represents the given set as a bit mask.

asBitSet

public static <X extends Enum<X> & EnumBitSetHelper<X>> BitSet asBitSet(EnumSet<X> set)

Creates a BitSet of a given set of enums.

Type Parameters:

X - Enum type of the elements.

Parameters:

set - A set of enum constants.

Returns:

New BitSet, equal to the given EnumSet.

asBitSet

@SafeVarargs
public static <X extends Enum<X> & EnumBitSetHelper<X>> BitSet asBitSet(X... set)

Creates a BitSet of a given set of enums.

Type Parameters:

X - Enum type of the elements.

Parameters:

set - A set of enum constants.

Returns:

A BitSet that represents the given set.

asEnumBitSet

public static <X extends Enum<X> & EnumBitSetHelper<X>> EnumBitSet<X> asEnumBitSet(BigInteger mask,
                                                                                   Class<X> type)

Creates set of enums from a bit set.

Type Parameters:

X - The class of the parameter elements and of the set

Parameters:

mask - A bit mask, must be positive.

type - The class of the parameter elements and of the set.

Returns:

New EnumBitSet, equal to the given bit mask.

asEnumBitSet

public static <X extends Enum<X> & EnumBitSetHelper<X>> EnumBitSet<X> asEnumBitSet(BitSet set,
                                                                                   Class<X> type)

Creates set of enums from a bit set.

Type Parameters:

X - The class of the parameter elements and of the set

Parameters:

set - A BitSet.

type - The class of the parameter elements and of the set.

Returns:

New EnumBitSet, equal to the BitSet.

asEnumBitSet

public static <X extends Enum<X> & EnumBitSetHelper<X>> EnumBitSet<X> asEnumBitSet(Collection<X> collection,
                                                                                   Class<X> type)

Creates a new EnumBitSet from a given Collection. The Collection must not contain null.

Type Parameters:

X - The class of the parameter elements and of the set

Parameters:

collection - A Collection of enum elements, not null and not containing null.

type - The class of the parameter elements and of the set.

Returns:

New EnumBitSet, equal to the Collection.

asEnumBitSet

public static <X extends Enum<X> & EnumBitSetHelper<X>> EnumBitSet<X> asEnumBitSet(EnumSet<X> set,
                                                                                   Class<X> type)

Creates a new EnumBitSet from a given BitSet.

Type Parameters:

X - The class of the parameter elements and of the set

Parameters:

set - An EnumSet.

type - The class of the parameter elements and of the set.

Returns:

New EnumBitSet, equal to the EnumSet.

asEnumBitSet

public static <X extends Enum<X> & EnumBitSetHelper<X>> EnumBitSet<X> asEnumBitSet(long mask,
                                                                                   Class<X> type)
                                                                            throws MoreThan64ElementsException

Creates set of enums from a long.

Type Parameters:

X - The class of the parameter elements and of the set

Parameters:

mask - A bit mask.

type - The class of the parameter elements and of the set.

Returns:

New EnumBitSet, equal to the given bit mask.

Throws:

MoreThan64ElementsException

asEnumSet

public static <X extends Enum<X> & EnumBitSetHelper<X>> EnumSet<X> asEnumSet(BigInteger mask,
                                                                             Class<X> type)

Creates set of enums from a bit set.

Type Parameters:

X - The class of the parameter elements and of the set

Parameters:

mask - A bit mask, must be positive.

type - The class of the parameter elements and of the set

Returns:

New EnumSet, equal to the given bit mask.

asEnumSet

public static <X extends Enum<X> & EnumBitSetHelper<X>> EnumSet<X> asEnumSet(BitSet bitset,
                                                                             Class<X> type)

Creates set of enums from a BitSet.

Type Parameters:

X - The class of the parameter elements and of the set

Parameters:

bitset - A BitSet.

type - The class of the parameter elements and of the set.

Returns:

New EnumSet, equal to the given BitSet.

asEnumSet

public static <X extends Enum<X> & EnumBitSetHelper<X>> EnumSet<X> asEnumSet(long mask,
                                                                             Class<X> type)
                                                                      throws MoreThan64ElementsException

Creates set of enums from a 64 bit bit set.

Type Parameters:

X - The enum type of the set.

Parameters:

mask - The bit mask.

type - The enum type of the set.

Returns:

New EnumSet with all elements of the given bit mask.

Throws:

MoreThan64ElementsException - This fails if the enum type contains more than 64 elements.

asEnumSet

@SafeVarargs
public static <X extends Enum<X> & EnumBitSetHelper<X>> EnumSet<X> asEnumSet(X first,
                                                                                           X... rest)

Creates set of enums from at least one element. It is recommended to use EnumSet.of(Enum, Enum...) directly!

Type Parameters:

X - The class of the parameter elements and of the set

Parameters:

first - an element that the set is to contain initially

rest - the remaining elements the set is to contain initially

Returns:

an EnumSet initially containing the specified elements. This is equal to: EnumSet.of(first, rest).

Throws:

NullPointerException - if any of the specified elements are null, or if rest is null

asLong

public static <X extends Enum<X> & EnumBitSetHelper<X>> long asLong(EnumSet<X> set)
                                                             throws MoreThan64ElementsException

Creates a 64 bit bitmask of a given set of enums.

Type Parameters:

X - Enum type of the elements.

Parameters:

set - An EnumSet af an enum type with up to 64 constants.

Returns:

A long value that represents the given set as a bit mask.

Throws:

MoreThan64ElementsException - This fails if any element in the set has a higher index than 63.

asLong

@SafeVarargs
public static <X extends Enum<X> & EnumBitSetHelper<X>> long asLong(X... set)
                                                                           throws MoreThan64ElementsException

Creates a 64 bit bit set of a given set of enums.

Type Parameters:

X - Enum type of the elements.

Parameters:

set - An EnumSet af an enum type with up to 64 constants.

Returns:

A long value that represents the given set as a bit mask.

Throws:

MoreThan64ElementsException - This fails if any element in the set has a higher index than 63.

just

public static <X extends Enum<X> & EnumBitSetHelper<X>> EnumBitSet<X> just(X value)

Returns a new EnumBitSet containing just one enum value.
Note: EnumBitSet.just(X) is equal to X.asEnumBitSet()

Type Parameters:

X - The enum type of the value.

Parameters:

value - The single value that will be contained in the result.

Returns:

New EnumBitSet containing nothing but value.

noneOf

public static <X extends Enum<X> & EnumBitSetHelper<X>> EnumBitSet<X> noneOf(Class<X> type)

Creates an EnumBitSet containing none of the elements in the specified element type.

Type Parameters:

X - The enum type.

Parameters:

type - Enum type.

Returns:

EnumBitSet containing no elements.

See Also:

of(Enum, Enum...), allOf(Class)

of

@SafeVarargs
public static <X extends Enum<X> & EnumBitSetHelper<X>> EnumBitSet<X> of(X first,
                                                                                       X... more)

Creates a new EnumBitSet containing at least one value.

Type Parameters:

X - The enum type of all elements.

Parameters:

first - The first element (must not be null).

more - More elements to add.

Returns:

New EnumBitSet containing all given elements.

See Also:

noneOf(Class)

range

public static <X extends Enum<X> & EnumBitSetHelper<X>> EnumBitSet<X> range(X from,
                                                                            X to)

Creates an enum set initially containing all of the elements in the range defined by the two specified endpoints. The returned set will contain the endpoints themselves, which may be identical but must not be out of order.

Type Parameters:

X - The class of the parameter elements and of the set

Parameters:

from - the first element in the range

to - the last element in the range

Returns:

an enum set initially containing all of the elements in the range defined by the two specified endpoints

Throws:

NullPointerException - if from or to are null

IllegalArgumentException - if from.compareTo(to) > 0

add

public boolean add(E e)

Specified by:

add in interface Collection<E extends Enum<E> & EnumBitSetHelper<E>>

addAll

public boolean addAll(Collection<? extends E> c)

Specified by:

addAll in interface Collection<E extends Enum<E> & EnumBitSetHelper<E>>

clear

public void clear()

Specified by:

clear in interface Collection<E extends Enum<E> & EnumBitSetHelper<E>>

clone

public EnumBitSet<E> clone()

Returns a copy of this set.

Specified by:

clone in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Overrides:

clone in class Object

Returns:

this.union(BigInteger.ZERO)

complement

public EnumBitSet<E> complement()

Creates a new EnumBitSet with the same element type as this, initially containing all the elements of this type that are not contained in this set.

Specified by:

complement in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Returns:

The complement of this EnumBitSet.

contains

public boolean contains(Object o)

Returns true if this set contains the specified element.

Specified by:

contains in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Specified by:

contains in interface Collection<E extends Enum<E> & EnumBitSetHelper<E>>

Parameters:

o - element whose presence in this collection is to be tested

Returns:

true if this set contains the specified element

See Also:

Collection.contains(Object)

containsAll

public boolean containsAll(Collection<?> c)

Returns true if this set contains all of the elements in the specified collection.

Specified by:

containsAll in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Specified by:

containsAll in interface Collection<E extends Enum<E> & EnumBitSetHelper<E>>

Parameters:

c - collection to be checked for containment in this collection

Returns:

true if this collection contains all of the elements in the specified collection

See Also:

Collection.containsAll(Collection), DomainBitSet.contains(Object)

cross

public <Y extends Enum<Y> & EnumBitSetHelper<Y>> Set<Pair<EnumBitSetHelper<?>,E,Y>> cross(EnumBitSet<Y> set)

The Cartesian product with another EnumBitSet. This overload only differs in that its generic return type uses Enum and EnumBitSetHelper instead of Object.

Type Parameters:

Y - The type of the elements in the given set.

Parameters:

set - Another set.

Returns:

a Set containing all pairs.

See Also:

DomainBitSet.cross(DomainBitSet), DomainBitSet.cross(DomainBitSet, BiConsumer), BitSetUtilities.cross(DomainBitSet, DomainBitSet, Class)

domainContains

public boolean domainContains(E object)

Is the given enum constant an element of this set's domain?

Specified by:

domainContains in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Parameters:

object - The object to be searched.

Returns:

object.getDeclaringClass() == this.enumType

equals

public boolean equals(Object other)

Compares the specified object with this domain bit set for equality. Returns true, iff the given object is also a DomainBitSet, the two sets have the same domain, and every member of the given set is contained in this set.

Specified by:

equals in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Specified by:

equals in interface Collection<E extends Enum<E> & EnumBitSetHelper<E>>

Overrides:

equals in class Object

Returns:

True, if this also a DomainBitSet, with the same domain and elements.

See Also:

DomainBitSet.equals(Object), DomainBitSet.ofEqualElements(DomainBitSet)

forEach

public void forEach(Consumer<? super E> action)

Specified by:

forEach in interface Iterable<E extends Enum<E> & EnumBitSetHelper<E>>

getBit

public boolean getBit(int bitIndex)
               throws IndexOutOfBoundsException

Returns the value of the bit with the specified index. The value is true if the bit with the index bitIndex is currently set in this BitSet; otherwise, the result is false.

Note that not all DomainBitSets are implemented as a bit set. In that case this method emulates the behavior of an actual bit set.

Specified by:

getBit in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Parameters:

bitIndex - the bit index

Returns:

the value of the bit with the specified index

Throws:

IndexOutOfBoundsException - if the specified index is negative or out of bounds.

See Also:

DomainBitSet.getElement(int)

getDomain

public Domain<E> getDomain()

The Domain containing all elements of the enum type.

Specified by:

getDomain in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Returns:

Domain with all enum elements.

See Also:

getEnumTypeSize()

getEnumType

public Class<E> getEnumType()

The enum type class that defines the available enum elements. This is the class returned by Enum.getDeclaringClass().

Returns:

The declaring class of all elements in this set.

getEnumTypeSize

public int getEnumTypeSize()

Amount of enum elements. This is relevant to know how large the bit field must be to hold a bit set of this type.

This is equal to getDomain().size(), but possibly faster.

Returns:

Number of constants of the enum type.

hashCode

public int hashCode()

Hash code of domain and elements.

Specified by:

hashCode in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Specified by:

hashCode in interface Collection<E extends Enum<E> & EnumBitSetHelper<E>>

Overrides:

hashCode in class Object

intersect

public EnumBitSet<E> intersect(BigInteger mask)

Returns a new EnumBitSet containing all elements that are in this and the given mask.

Specified by:

intersect in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Parameters:

mask - Another set, represented by a bit mask, must be positive.

Returns:

this ∩ set

See Also:

complement()

intersect

public EnumBitSet<E> intersect(BitSet set)

Returns a new EnumBitSet containing all elements that are in this and the given set.

Specified by:

intersect in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Parameters:

set - Another set.

Returns:

this ∩ set

See Also:

complement()

intersect

public EnumBitSet<E> intersect(EnumBitSet<E> set)

Returns a new EnumBitSet containing all elements that are in this and the given set.

Parameters:

set - Another set.

Returns:

this ∩ set

See Also:

complement()

intersect

public EnumBitSet<E> intersect(EnumSet<E> set)

Returns a new EnumBitSet containing all elements that are in this and the given set.

Parameters:

set - Another set.

Returns:

this ∩ set

See Also:

complement()

intersect

public EnumBitSet<E> intersect(Iterable<E> set)

Returns a new EnumBitSet containing all elements that are in this and the given set.

Specified by:

intersect in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Parameters:

set - Another set.

Returns:

this ∩ set

See Also:

complement()

intersect

public EnumBitSet<E> intersect(long mask)
                        throws MoreThan64ElementsException

Returns a new EnumBitSet containing all elements that are in this and the given mask.

Specified by:

intersect in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Parameters:

mask - Another set, represented by a bit mask.

Returns:

this ∩ set

Throws:

MoreThan64ElementsException - This fails if any element in the set has a higher index than 63.

See Also:

complement()

intersectVarArgs

public EnumBitSet<E> intersectVarArgs(E... set)

Returns a new EnumBitSet containing all elements that are in this and the given set.

Specified by:

intersectVarArgs in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Parameters:

set - Another set.

Returns:

this ∩ set

See Also:

complement()

isEmpty

public boolean isEmpty()

Returns true if this set contains no elements.

Specified by:

isEmpty in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Specified by:

isEmpty in interface Collection<E extends Enum<E> & EnumBitSetHelper<E>>

Returns:

true if this set contains no elements

See Also:

Collection.isEmpty()

iterator

public Iterator<E> iterator()

Returns an iterator over elements of type T.

The order is not defined as this could be backed by a set. Iteration in the same order as the domain can be done like this:
domainBitSet.getDomain().stream().filter(domainBitSet::contains).forEach(...)

Specified by:

iterator in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Specified by:

iterator in interface Iterable<E extends Enum<E> & EnumBitSetHelper<E>>

Specified by:

iterator in interface Collection<E extends Enum<E> & EnumBitSetHelper<E>>

map

public <S extends Enum<S> & EnumBitSetHelper<S>> EnumBitSet<S> map(Class<S> newEnumType)

Returns a new set with elements of a given enum type, containing all elements of the other enum type.

Mapping is done by the ordinal of each enum constant. Therefore the given enum type must not contain less constants than the enum type of this set.

Type Parameters:

S - Type of given enum domain.

Parameters:

newEnumType - The new enum type.

Returns:

new set, using the given enum type.

Throws:

IllegalArgumentException - if the given enum type contains less constants.

See Also:

map(Domain, Function), map(Class, Function), Stream.map(Function)

map

public <S extends Enum<S> & EnumBitSetHelper<S>> EnumBitSet<S> map(Class<S> newEnumType,
                                                                   Function<E,S> mapper)

Returns a new set with elements of a given enum type, containing all mapped elements.

This is a convenience method. The same can be done with: this.stream().map(mapper)

Type Parameters:

S - Type of given enum domain.

Parameters:

newEnumType - The new enum type.

mapper - function to map from E to S.

Returns:

new set, using the given enum type.

See Also:

map(Domain, Function), map(Domain, Function), Stream.map(Function)

map

public <S> DomainBitSet<S> map(Domain<S> newDomain,
                               Function<E,S> mapper)

Returns a new set with elements of a given domain, containing all mapped elements.

This is a convenience method. The same can be done with: this.stream().map(mapper)

This returns an EnumBitSet if the given Domain originates from an EnumBitSet.

Specified by:

map in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Type Parameters:

S - Type of given domain.

Parameters:

newDomain - The new domain

mapper - function to map from T to S.

Returns:

new set, using the given domain.

See Also:

map(Class, Function)

minus

public EnumBitSet<E> minus(BigInteger mask)

Returns a new EnumBitSet containing all elements that are in this, but not in the given mask.

Specified by:

minus in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Parameters:

mask - Another set, represented by a bit mask, must be positive.

Returns:

this ∖ mask

See Also:

removeAll(Collection)

minus

public EnumBitSet<E> minus(BitSet set)

Returns a new EnumBitSet containing all elements that are in this, but not in the given bit set.

Specified by:

minus in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Parameters:

set - Another set.

Returns:

this ∖ set

See Also:

removeAll(Collection)

minus

public EnumBitSet<E> minus(EnumBitSet<E> set)

Returns a new EnumBitSet containing all elements that are in this, but not in the given set.

Parameters:

set - Another set.

Returns:

this ∖ set

See Also:

removeAll(Collection)

minus

public EnumBitSet<E> minus(EnumSet<E> set)

Returns a new EnumBitSet containing all elements that are in this, but not in the given set.

Parameters:

set - Another set.

Returns:

this ∖ set

See Also:

removeAll(Collection)

minus

public EnumBitSet<E> minus(Iterable<E> set)

Returns a new EnumBitSet containing all elements that are in this, but not in the given set.

Specified by:

minus in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Parameters:

set - Another set.

Returns:

this ∖ mask

See Also:

removeAll(Collection)

minus

public EnumBitSet<E> minus(long mask)
                    throws MoreThan64ElementsException

Returns a new EnumBitSet containing all elements that are in this, but not in the given mask.

Specified by:

minus in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Parameters:

mask - Another set, represented by a bit mask.

Returns:

this ∖ mask

Throws:

MoreThan64ElementsException - This fails if any element in this set has a higher index than 63.

See Also:

removeAll(Collection)

minusVarArgs

public EnumBitSet<E> minusVarArgs(E... set)

Returns a new EnumBitSet containing all elements that are in this, but not in the given set.

Specified by:

minusVarArgs in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Parameters:

set - Another set.

Returns:

this ∖ set

See Also:

removeAll(Collection)

ofEqualDomain

public boolean ofEqualDomain(DomainBitSet<E> set)

Description copied from interface: DomainBitSet

Compares the domains.

This is equal to, but could be a bit faster than this.getDomain().equals(set.getDomain()).

Specified by:

ofEqualDomain in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Parameters:

set - The other set.

Returns:

true if both are of equal domains.

parallelStream

public Stream<E> parallelStream()

Description copied from interface: DomainBitSet

Returns a possibly parallel Stream with this set as its source. It is allowable for this method to return a sequential stream.

Specified by:

parallelStream in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Specified by:

parallelStream in interface Collection<E extends Enum<E> & EnumBitSetHelper<E>>

Returns:

a possibly parallel Stream over the elements in this set

See Also:

Collection.parallelStream()

powerset

public Iterable<EnumBitSet<E>> powerset()
                                 throws MoreThan64ElementsException

Description copied from interface: DomainBitSet

The powerset, which is the set of all subsets.

Note: Complexity is O(2n). For sets with more than 64 elements this would be insanely large. Therefore this is limited to sets with up to 64 elements. However, the size of the domain does not matter.

This is not thread safe and has to be processed sequentially.

Specified by:

powerset in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Returns:

The powerset of this set.

Throws:

MoreThan64ElementsException - if this set contains more than 64 elements. This would result in more than 18E18 subsets.

See Also:

DomainBitSet.powerset(Consumer, boolean)

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<E extends Enum<E> & EnumBitSetHelper<E>>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<E extends Enum<E> & EnumBitSetHelper<E>>

See Also:

minusVarArgs(Enum...), minus(EnumBitSet), minus(EnumSet), minus(BigInteger)

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<E extends Enum<E> & EnumBitSetHelper<E>>

See Also:

intersect(BigInteger), intersect(BitSet), intersectVarArgs(Enum...), intersect(EnumBitSet), intersect(EnumSet), intersect(long)

size

public int size()

The number of elements in this set.

Not to be confused with getEnumTypeSize().

Specified by:

size in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Specified by:

size in interface Collection<E extends Enum<E> & EnumBitSetHelper<E>>

Returns:

The number of elements in this set.

See Also:

Collection.size()

spliterator

public Spliterator<E> spliterator()

Creates a Spliterator over the elements in this collection.

Specified by:

spliterator in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Specified by:

spliterator in interface Iterable<E extends Enum<E> & EnumBitSetHelper<E>>

Specified by:

spliterator in interface Collection<E extends Enum<E> & EnumBitSetHelper<E>>

Returns:

a Spliterator over the elements in this collection

See Also:

Collection.spliterator()

stream

public Stream<E> stream()

Description copied from interface: DomainBitSet

Returns a sequential Stream with this collection as its source.

Specified by:

stream in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Specified by:

stream in interface Collection<E extends Enum<E> & EnumBitSetHelper<E>>

Returns:

a sequential Stream over the elements in this collection

See Also:

Collection.stream()

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<E extends Enum<E> & EnumBitSetHelper<E>>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<E extends Enum<E> & EnumBitSetHelper<E>>

toBigInteger

public BigInteger toBigInteger()

Returns a BigInteger that represents this set.

Specified by:

toBigInteger in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Returns:

A representation of this EnumBitSet as a BigInteger .

See Also:

toBinaryString()

toBinaryString

public String toBinaryString()

Binary string representation of this set.

The length of the returned string is the same as the amount of enum elements in the enum type.

Returns:

A representation of this EnumBitSet as a String of 0s and 1s.

toBinaryString

public String toBinaryString(int width)

Binary string representation of this set.

The length of the returned string is as least as long as width.

Example: Use this if you have an enum type with less than 64 elements but you want to use a bit field with 64 bits. this.toBinaryString(64) will already have the appropriate length.

Parameters:

width - The minimal width of the returned String.

Returns:

A representation of this EnumBitSet as a String of 0s and 1s. The length is at least width.

toBitSet

public BitSet toBitSet()

Returns a new BitSet that represents this set.

Specified by:

toBitSet in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Returns:

A representation of this EnumBitSet as a BitSet;

toEnumSet

public EnumSet<E> toEnumSet()

Copy of the underlying EnumSet.

Returns:

bitset.clone()

toLong

public long toLong()
            throws MoreThan64ElementsException

Returns a long value that represents this set.

Specified by:

toLong in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Returns:

A representation of this EnumBitSet as a long.

Throws:

MoreThan64ElementsException - This fails if any element in this set has a higher index than 63.

toSet

public Set<E> toSet()

Copy of the underlying EnumSet.

Specified by:

toSet in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Returns:

bitset.clone()

toString

public String toString()

Returns a string representation of this set.

Overrides:

toString in class Object

See Also:

AbstractCollection.toString()

union

public EnumBitSet<E> union(BigInteger mask)

Returns a new EnumBitSet containing all elements that are in this or the given mask.

Specified by:

union in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Parameters:

mask - Bit mask of another set, must be positive.

Returns:

this ∪ set

Throws:

IllegalArgumentException - The bit mask must not have any bits set that are not mapped to an enum constant.

union

public EnumBitSet<E> union(BitSet set)

Returns a new EnumBitSet containing all elements that are in this or the given set.

Specified by:

union in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Parameters:

set - Another set.

Returns:

this ∪ set

Throws:

IllegalArgumentException - The bit set must not have any bits set that are not mapped to an enum constant.

union

public EnumBitSet<E> union(EnumBitSet<E> set)

Returns a new EnumBitSet containing all elements that are in this or the given set.

Parameters:

set - Another set.

Returns:

this ∪ set

union

public EnumBitSet<E> union(EnumSet<E> set)

Returns a new EnumBitSet containing all elements that are in this or the given set.

Parameters:

set - Another set.

Returns:

this ∪ set

union

public EnumBitSet<E> union(Iterable<E> set)

Description copied from interface: DomainBitSet

The union of this set and a set represented by an iterable collection.

Specified by:

union in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Parameters:

set - An Iterable representing another set.

Returns:

The union of this set and the given set.

union

public EnumBitSet<E> union(long mask)
                    throws MoreThan64ElementsException

Returns a new EnumBitSet containing all elements that are in this or the given mask.

Specified by:

union in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Parameters:

mask - Bit mask of another set.

Returns:

this ∪ set

Throws:

MoreThan64ElementsException - This fails if any element in this set has a higher index than 63.

unionVarArgs

public EnumBitSet<E> unionVarArgs(E... set)

Returns a new EnumBitSet containing all elements that are in this or the given set.

Specified by:

unionVarArgs in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Parameters:

set - Another set.

Returns:

this ∪ set

See Also:

DomainBitSet.union(Iterable)

zipWithPosition

public Stream<Pair<Object,Integer,E>> zipWithPosition()

Returns a sequential stream with pairs of all elements of this set and their position in the domain.

This can be collected to a Map using toTreeMap.

As this uses enum types the position is always the ordinal of the constant.

Specified by:

zipWithPosition in interface DomainBitSet<E extends Enum<E> & EnumBitSetHelper<E>>

Returns:

A stream of elements and their position.

See Also:

BitSetUtilities.toTreeMap(), DomainBitSet.getElement(int)