ch.claude_martin.enumbitset

Class BitSetUtilities

java.lang.Object

ch.claude_martin.enumbitset.BitSetUtilities

public final class BitSetUtilities
extends Object

A collection of utility methods for DomainBitSets.

Author:

Copyright © 2014 Claude Martin

Constructor Summary

Constructors

Constructor and Description
BitSetUtilities()

Method Summary

Modifier and Type	Method and Description
static BigInteger	asBigInteger(BitSet bitset) Creates a BigInteger of a given bit set.
static BigInteger	asBigInteger(long mask) Converts a long to a positive (unsigned) integer.
static BitSet	asBitSet(BigInteger mask) Creates a BitSet of a given mask.
static <X extends Enum<X> & EnumBitSetHelper<X>> BitSet	asBitSet(long mask) Creates a BitSet of a given bit mask.
static long	asLong(BigInteger mask) Converts a BigInteger to long.
static long	asLong(BitSet bitset) Converts a BitSet to long.
static <C,T1 extends C,T2 extends C> Set<Pair<C,T1,T2>>	cross(DomainBitSet<T2> set1, DomainBitSet<T2> set2, Class<C> type) Returns the Cartesian Product.
static <T> DomainBitSet<T>	intersect(DomainBitSet<T> set1, DomainBitSet<T> set2) Returns the intersection of two sets.
static <T> DomainBitSet<T>	minus(DomainBitSet<T> set1, DomainBitSet<T> set2) Returns the relative complement of two sets.
static <T> Collector<T,Set<T>,DomainBitSet<T>>	toDomainBitSet(Domain<T> domain) Collector to convert a Stream to a DomainBitSet.
static <T,D extends DomainBitSet<T>> Collector<T,Set<T>,D>	toDomainBitSet(Function<Collection<T>,D> bitsetFactory) Collector to convert a Stream to a DomainBitSet.
static <T> Collector<Pair<Object,Integer,T>,?,TreeMap<Integer,T>>	toTreeMap() Collector to convert a Stream of Pairs to a TreeMap.
static <T> DomainBitSet<T>	union(DomainBitSet<T> set1, DomainBitSet<T> set2) Returns the union of two sets.

Methods inherited from class java.lang.Object

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

Constructor Detail

BitSetUtilities

public BitSetUtilities()

Method Detail

asBigInteger

public static BigInteger asBigInteger(BitSet bitset)

Creates a BigInteger of a given bit set. The value is a positive value with the same "value" as the bit set.

Parameters:

bitset - A bit set.

Returns:

The bit mask.

asBigInteger

public static BigInteger asBigInteger(long mask)

Converts a long to a positive (unsigned) integer.

Parameters:

mask - A long value that represents a bit set.

Returns:

Positive (unsigned) value.

asBitSet

public static BitSet asBitSet(BigInteger mask)

Creates a BitSet of a given mask.

Parameters:

mask - A bit mask, must be positive.

Returns:

New BitSet, equal to the given bit mask.

asBitSet

public static <X extends Enum<X> & EnumBitSetHelper<X>> BitSet asBitSet(long mask)

Creates a BitSet of a given bit mask.

This method can not check if there are more than 64 elements on the enum type, as the enum type is not known. It simply converts a long to a bitset.

Type Parameters:

X - Enum type of the elements.

Parameters:

mask - A bit mask.

Returns:

A BitSet that represents the given set.

asLong

public static long asLong(BigInteger mask)

Converts a BigInteger to long.

Parameters:

mask - A bit mask, must be positive and lower than 2⁶⁴.

Returns:

A long value representing the given BigInteger, if it is valid (bit length = 64).

Throws:

IllegalArgumentException - Only positive values with up to 64 bits are allowed.

asLong

public static long asLong(BitSet bitset)

Converts a BitSet to long.

Parameters:

bitset - A bit set.

Returns:

A long value representing the given bit set.

Throws:

IllegalArgumentException - Only bit sets with using up to 64 bits are allowed.

cross

public static <C,T1 extends C,T2 extends C> Set<Pair<C,T1,T2>> cross(DomainBitSet<T2> set1,
                                                                     DomainBitSet<T2> set2,
                                                                     Class<C> type)

Returns the Cartesian Product. This makes it easy to use some common supertype of both types.

Example: If the types are Integer and Double then the supertype Number can be used.

The returned set has a size of this.size() * set.size(). The given type has to be a super type of both other types.

Type Parameters:

C - A common base type.

T1 - The type of the elements in the first set.

T2 - The type of the elements in the second set.

Parameters:

set1 - A set.

set2 - Another set.

Returns:

the Cartesian Product.

See Also:

DomainBitSet.cross(DomainBitSet), DomainBitSet.cross(DomainBitSet, BiConsumer)

intersect

public static <T> DomainBitSet<T> intersect(DomainBitSet<T> set1,
                                            DomainBitSet<T> set2)

Returns the intersection of two sets.

Type Parameters:

T - The type of the domain.

Parameters:

set1 - The first set.

set2 - The second set.

Returns:

The intersection of both sets.

See Also:

BinaryOperator, DomainBitSet.intersect(Iterable)

minus

public static <T> DomainBitSet<T> minus(DomainBitSet<T> set1,
                                        DomainBitSet<T> set2)

Returns the relative complement of two sets.

Type Parameters:

T - The type of the domain.

Parameters:

set1 - The first set.

set2 - The second set.

Returns:

The relative complement of both sets.

See Also:

BinaryOperator, DomainBitSet.minus(Iterable)

toDomainBitSet

public static <T> Collector<T,Set<T>,DomainBitSet<T>> toDomainBitSet(Domain<T> domain)

Collector to convert a Stream to a DomainBitSet.

Type Parameters:

T - Type of elements.

Parameters:

domain - the Domain to create the DomainBitSet.

Returns:

New Collector to collect elements into a DomainBitSet.

See Also:

Domain.factory(), Collectors.toCollection(Supplier)

toDomainBitSet

public static <T,D extends DomainBitSet<T>> Collector<T,Set<T>,D> toDomainBitSet(Function<Collection<T>,D> bitsetFactory)

Collector to convert a Stream to a DomainBitSet.

Type Parameters:

T - Type of elements.

D - Type of DomainBitSet.

Parameters:

bitsetFactory - Creates an empty bitset.

Returns:

New Collector to collect elements into a DomainBitSet.

See Also:

Collectors.toCollection(Supplier)

toTreeMap

public static <T> Collector<Pair<Object,Integer,T>,?,TreeMap<Integer,T>> toTreeMap()

Collector to convert a Stream of Pairs to a TreeMap.

A stream with multiple entries for the same position will cause a IllegalStateException.

Type Parameters:

T - the type of the elements.

Returns:

a Collector

See Also:

DomainBitSet.zipWithPosition()

union

public static <T> DomainBitSet<T> union(DomainBitSet<T> set1,
                                        DomainBitSet<T> set2)

Returns the union of two sets.

Type Parameters:

T - The type of the domain.

Parameters:

set1 - The first set.

set2 - The second set.

Returns:

The union of both sets.

See Also:

BinaryOperator, DomainBitSet.union(Iterable)