SmallDomainBitSet

java.lang.Object
- ch.claude_martin.enumbitset.SmallDomainBitSet<T>

Type Parameters:

T - The type of the domain. All elements in the domain must be of type T or of any subtype of T.

All Implemented Interfaces:

DomainBitSet<T>, Serializable, Cloneable, Iterable<T>
```
public class SmallDomainBitSet<T>
extends Object
implements DomainBitSet<T>, Cloneable
```
BitSet with a domain of up to 64 elements. This is checked at creation, so that it is not thrown later. However, a mask that has a larger domain causes an IllegalArgumentException instead.

See Also:

Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static <T> SmallDomainBitSet<T>`	`allOf(List<T> domain)` Creates a set with the given domain, that contains all elements.
`static <T> SmallDomainBitSet<T>`	`allOf(T... domain)` Creates a set with the given domain, that contains all elements.
`SmallDomainBitSet<T>`	`clone()` Default implementation of a `cloning-method` using `DomainBitSet.union(BigInteger)`.
`DomainBitSet<T>`	`complement()` Creates a new set with the same domain, initially containing all the elements of the domain that are not contained in this set.
`boolean`	`equals(Object other)` Compares the specified object with this domain bit set for equality.
`boolean`	`getBit(int bitIndex)` Returns the value of the bit with the specified index.
`Domain<T>`	`getDomain()` Returns a distinct list, containing all elements of the domain.
`int`	`hashCode()` Hash code of domain and elements.
`DomainBitSet<T>`	`intersect(BigInteger mask)` The intersection of this and a given mask.
`DomainBitSet<T>`	`intersect(BitSet s)` The intersection of this and a given bit set.
`DomainBitSet<T>`	`intersect(Iterable<T> s)` Intersection of this and the given set.
`DomainBitSet<T>`	`intersect(long mask)` Intersection of this and the given set.
`DomainBitSet<T>`	`intersectVarArgs(T... elements)` The intersection of this set and a set represented by an array (varargs).
`boolean`	`isEmpty()` Returns `true` if this set contains no elements.
`Iterator<T>`	`iterator()` Returns an iterator over elements of type T.
`DomainBitSet<T>`	`minus(BigInteger mask)` The relative complement of this set and a set represented by a `BigInteger`.
`DomainBitSet<T>`	`minus(BitSet s)` The relative complement of this set and a set represented by a `BitSet`.
`DomainBitSet<T>`	`minus(Iterable<T> s)` The relative complement of this set and another set.
`DomainBitSet<T>`	`minus(long mask)` The relative complement of this set and a set represented by a bit mask.
`DomainBitSet<T>`	`minusVarArgs(T... elements)` The relative complement of this set and a set represented by an array (varargs).
`static <T> SmallDomainBitSet<T>`	`noneOf(List<T> domain)` Creates a set with the given domain, that contains none of the elements.
`static <T> SmallDomainBitSet<T>`	`noneOf(T... domain)` Creates a set with the given domain, that contains none of the elements.
`static <T> SmallDomainBitSet<T>`	`of(List<T> domain, Collection<T> set)` Creates a set with the given domain, containing all given elements.
`static <T> SmallDomainBitSet<T>`	`of(List<T> domain, long mask)` Creates a set with the given domain, containing elements according to a given bit mask.
`static <T> SmallDomainBitSet<T>`	`of(List<T> domain, T... set)` Creates a set with the given domain, containing all given elements.
`boolean`	`ofEqualElements(DomainBitSet<T> other)` Compares the elements, ignoring the domains.
`Iterable<SmallDomainBitSet<T>>`	`powerset()` The powerset, which is the set of all subsets.
`void`	`powerset(Consumer<DomainBitSet<T>> consumer, boolean blocking)` Pass all subsets to a given consumer.
`int`	`size()` The number of elements in this set.
`Spliterator<T>`	`spliterator()` Creates a `Spliterator` over the elements in this collection.
`BigInteger`	`toBigInteger()` A representation of the elements in this set as a `BigInteger`.
`BitSet`	`toBitSet()` A representation of the elements in this set as a `BitSet`.
`long`	`toLong()` A representation of the elements in this set as a `long`.
`Set<T>`	`toSet()` A regular set, with no defined domain.
`String`	`toString()`
`DomainBitSet<T>`	`union(BigInteger mask)` The union of this set and a set represented by a `BitSet`.
`DomainBitSet<T>`	`union(BitSet s)` The union of this set and a set represented by a `BitSet`.
`DomainBitSet<T>`	`union(Iterable<T> s)` The union of this set and a set represented by an `iterable` collection.
`DomainBitSet<T>`	`union(long mask)` The union of this set and a set represented by a bit mask.
`DomainBitSet<T>`	`unionVarArgs(T... elements)` The union of this set and a set represented by an array (varargs).
`Stream<Pair<Object,Integer,T>>`	`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
contains, containsAll, createMultiEnumBitSet, cross, cross, domainContains, getElement, map, map, ofEqualDomain, parallelStream, semijoin, stream

Methods inherited from interface java.lang.Iterable
forEach

- Method Detail
  - allOf
```
public static <T> SmallDomainBitSet<T> allOf(List<T> domain)
                                      throws MoreThan64ElementsException
```
    Creates a set with the given domain, that contains all elements.
    
    Specified by:
    
    allOf in interface DomainBitSet<T>
    
    Type Parameters:
    
    T - The type of the set and its domain.
    
    Parameters:
    
    domain - The type of the domain.
    
    Returns:
    
    A SmallDomainBitSet containing all elements of the given domain.
    
    Throws:
    
    MoreThan64ElementsException
  - allOf
```
@SafeVarargs
public static <T> SmallDomainBitSet<T> allOf(T... domain)
                                                    throws MoreThan64ElementsException
```
    Creates a set with the given domain, that contains all elements.
    
    Specified by:
    
    allOf in interface DomainBitSet<T>
    
    Type Parameters:
    
    T - The type of the domain.
    
    Parameters:
    
    domain - The domain.
    
    Returns:
    
    A SmallDomainBitSet containing all elements of the given domain.
    
    Throws:
    
    MoreThan64ElementsException
  - noneOf
```
public static <T> SmallDomainBitSet<T> noneOf(List<T> domain)
                                       throws MoreThan64ElementsException
```
    Creates a set with the given domain, that contains none of the elements.
    
    Specified by:
    
    noneOf in interface DomainBitSet<T>
    
    Type Parameters:
    
    T - The type of the set and its domain.
    
    Parameters:
    
    domain - The elements of the domain.
    
    Returns:
    
    Empty SmallDomainBitSet based on the given domain.
    
    Throws:
    
    MoreThan64ElementsException
  - noneOf
```
@SafeVarargs
public static <T> SmallDomainBitSet<T> noneOf(T... domain)
```
    Creates a set with the given domain, that contains none of the elements.
    
    Specified by:
    
    noneOf in interface DomainBitSet<T>
    
    Type Parameters:
    
    T - The type of the set and its domain.
    
    Parameters:
    
    domain - The elements of the domain.
    
    Returns:
    
    Empty SmallDomainBitSet based on the given domain.
  - of
```
public static <T> SmallDomainBitSet<T> of(List<T> domain,
                                          Collection<T> set)
```
    Creates a set with the given domain, containing all given elements.
    
    Type Parameters:
    
    T - The type of the set and its domain.
    
    Parameters:
    
    domain - The elements of the domain.
    
    set - The elements.
    
    Returns:
    
    SmallDomainBitSet based on the given domain and set.
  - of
```
public static <T> SmallDomainBitSet<T> of(List<T> domain,
                                          long mask)
```
    Creates a set with the given domain, containing elements according to a given bit mask.
    
    Type Parameters:
    
    T - The type of the set and its domain.
    
    Parameters:
    
    domain - The elements of the domain.
    
    mask - The elements as a bit mask.
    
    Returns:
    
    SmallDomainBitSet based on the given domain and bit mask.
  - of
```
@SafeVarargs
public static <T> SmallDomainBitSet<T> of(List<T> domain,
                                                        T... set)
```
    Creates a set with the given domain, containing all given elements.
    
    Type Parameters:
    
    T - The type of the set and its domain.
    
    Parameters:
    
    domain - The elements of the domain.
    
    set - The elements.
    
    Returns:
    
    SmallDomainBitSet based on the given domain and set.
  - clone
```
public SmallDomainBitSet<T> clone()
```
    Description copied from interface: DomainBitSet
    
    Default implementation of a cloning-method using DomainBitSet.union(BigInteger).
    
    Specified by:
    
    clone in interface DomainBitSet<T>
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    this.union(BigInteger.ZERO)
  - complement
```
public DomainBitSet<T> complement()
```
    Description copied from interface: DomainBitSet
    
    Creates a new set with the same domain, initially containing all the elements of the domain that are not contained in this set.
    
    Specified by:
    
    complement in interface DomainBitSet<T>
    
    Returns:
    
    The complement of this set.
  - equals
```
public boolean equals(Object other)
```
    Description copied from interface: DomainBitSet
    
    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.
    Comparison of elements only:
    this.ofEqualElements(other)
    Which is equivalent to:
    this.toSet().equals(other.toSet())
    Comparison of domain only:
    this.ofEqualDomain(other)
    
    Specified by:
    
    equals in interface DomainBitSet<T>
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    True, if this also a DomainBitSet, with the same domain and elements.
    
    See Also:
    
    DomainBitSet.ofEqualElements(DomainBitSet)
  - getBit
```
public boolean getBit(int bitIndex)
               throws IndexOutOfBoundsException
```
    Description copied from interface: DomainBitSet
    
    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<T>
    
    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.contains(Object), BitSet.get(int), BigInteger.testBit(int)
  - getDomain
```
public Domain<T> getDomain()
```
    Description copied from interface: DomainBitSet
    
    Returns a distinct list, containing all elements of the domain. There is no guarantee that the set is the same for multiple invocations.
    All elements are ordered as they are defined in the domain.
    Note that the returned set is immutable.
    
    Specified by:
    
    getDomain in interface DomainBitSet<T>
    
    Returns:
    
    The Domain of this set.
  - hashCode
```
public int hashCode()
```
    Description copied from interface: DomainBitSet
    
    Hash code of domain and elements.
    
    Specified by:
    
    hashCode in interface DomainBitSet<T>
    
    Overrides:
    
    hashCode in class Object
  - intersect
```
public DomainBitSet<T> intersect(BigInteger mask)
```
    Description copied from interface: DomainBitSet
    
    The intersection of this and a given mask.
    
    Specified by:
    
    intersect in interface DomainBitSet<T>
    
    Parameters:
    
    mask - The mask of the other set.
    
    Returns:
    
    Intersection of this and the given mask.
  - intersect
```
public DomainBitSet<T> intersect(BitSet s)
```
    Description copied from interface: DomainBitSet
    
    The intersection of this and a given bit set.
    
    Specified by:
    
    intersect in interface DomainBitSet<T>
    
    Parameters:
    
    s - The bit set representation of the other set.
    
    Returns:
    
    Intersection of this and the given bit set.
  - intersect
```
public DomainBitSet<T> intersect(Iterable<T> s)
```
    Description copied from interface: DomainBitSet
    
    Intersection of this and the given set.
    
    Specified by:
    
    intersect in interface DomainBitSet<T>
    
    Parameters:
    
    s - An Iterable collection of elements from the domain.
    
    Returns:
    
    Intersection of this and the given collection.
  - intersect
```
public DomainBitSet<T> intersect(long mask)
                          throws IllegalArgumentException
```
    Description copied from interface: DomainBitSet
    
    Intersection of this and the given set.
    
    Specified by:
    
    intersect in interface DomainBitSet<T>
    
    Parameters:
    
    mask - The bit mask of another set.
    
    Returns:
    
    A new DomainBitSet that represents the intersection.
    
    Throws:
    
    IllegalArgumentException - If the domain contains less than 64 elements then some long values are illegal.
  - intersectVarArgs
```
public DomainBitSet<T> intersectVarArgs(T... elements)
```
    Description copied from interface: DomainBitSet
    
    The intersection of this set and a set represented by an array (varargs). The name is different so that it is unambiguous.
    
    Specified by:
    
    intersectVarArgs in interface DomainBitSet<T>
    
    Parameters:
    
    elements - A set as an array. Duplicates are ignored. Must not be nor contain null.
    
    Returns:
    
    The intersection of this and the given set.
    
    See Also:
    
    DomainBitSet.intersect(Iterable)
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: DomainBitSet
    
    Returns true if this set contains no elements.
    
    Specified by:
    
    isEmpty in interface DomainBitSet<T>
    
    Returns:
    
    true if this set contains no elements
    
    See Also:
    
    Collection.isEmpty()
  - iterator
```
public Iterator<T> iterator()
```
    Description copied from interface: DomainBitSet
    
    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<T>
    
    Specified by:
    
    iterator in interface Iterable<T>
  - minus
```
public DomainBitSet<T> minus(BigInteger mask)
```
    Description copied from interface: DomainBitSet
    
    The relative complement of this set and a set represented by a BigInteger.
    
    Specified by:
    
    minus in interface DomainBitSet<T>
    
    Parameters:
    
    mask - The other set as a bit mask.
    
    Returns:
    
    The relative complement of this and the given set.
  - minus
```
public DomainBitSet<T> minus(BitSet s)
```
    Description copied from interface: DomainBitSet
    
    The relative complement of this set and a set represented by a BitSet.
    
    Specified by:
    
    minus in interface DomainBitSet<T>
    
    Parameters:
    
    s - The other set.
    
    Returns:
    
    The relative complement of this and the given set.
  - minus
```
public DomainBitSet<T> minus(Iterable<T> s)
```
    Description copied from interface: DomainBitSet
    
    The relative complement of this set and another set.
    
    Specified by:
    
    minus in interface DomainBitSet<T>
    
    Parameters:
    
    s - The other set.
    
    Returns:
    
    The relative complement of this and the given set.
  - minus
```
public DomainBitSet<T> minus(long mask)
                      throws IllegalArgumentException
```
    Description copied from interface: DomainBitSet
    
    The relative complement of this set and a set represented by a bit mask.
    
    Specified by:
    
    minus in interface DomainBitSet<T>
    
    Parameters:
    
    mask - The mask representing the other set.
    
    Returns:
    
    The relative complement of this and the given set.
    
    Throws:
    
    IllegalArgumentException - If the domain contains less than 64 elements then some long values are illegal.
  - minusVarArgs
```
public DomainBitSet<T> minusVarArgs(T... elements)
```
    Description copied from interface: DomainBitSet
    
    The relative complement of this set and a set represented by an array (varargs). The name is different so that it is unambiguous.
    
    Specified by:
    
    minusVarArgs in interface DomainBitSet<T>
    
    Parameters:
    
    elements - A set as an array. Duplicates are ignored. Must not be nor contain null.
    
    Returns:
    
    The relative complement of this and the given set.
    
    See Also:
    
    DomainBitSet.minus(Iterable)
  - ofEqualElements
```
public boolean ofEqualElements(DomainBitSet<T> other)
```
    Description copied from interface: DomainBitSet
    
    Compares the elements, ignoring the domains.
    This is equal to, but could be a bit faster than this.toSet().equals(set.toSet()).
    
    Specified by:
    
    ofEqualElements in interface DomainBitSet<T>
    
    Parameters:
    
    other - The other set.
    
    Returns:
    
    true if both contain the same elements.
    
    See Also:
    
    Set.equals(Object)
  - powerset
```
public Iterable<SmallDomainBitSet<T>> powerset()
```
    The powerset, which is the set of all subsets.
    Note: Complexity is O(2ⁿ). This takes very long for large sets.
    This is not thread safe and has to be processed sequentially.
    
    Specified by:
    
    powerset in interface DomainBitSet<T>
    
    Returns:
    
    The powerset of this set.
    
    See Also:
    
    powerset(Consumer, boolean)
  - powerset
```
public void powerset(Consumer<DomainBitSet<T>> consumer,
                     boolean blocking)
```
    Pass all subsets to a given consumer.
    The consumer must be thread-safe. This will process all possible subsets concurrently, using an ExecutorService. For better performance this uses SmallDomainBitSet only.
    
    Specified by:
    
    powerset in interface DomainBitSet<T>
    
    Parameters:
    
    consumer - to process each subset
    
    blocking - if true this will block until all are processed
    
    See Also:
    
    powerset()
  - size
```
public int size()
```
    Description copied from interface: DomainBitSet
    
    The number of elements in this set.
    
    Specified by:
    
    size in interface DomainBitSet<T>
    
    Returns:
    
    The number of elements in this set.
    
    See Also:
    
    Collection.size()
  - spliterator
```
public Spliterator<T> spliterator()
```
    Description copied from interface: DomainBitSet
    
    Creates a Spliterator over the elements in this collection.
    
    Specified by:
    
    spliterator in interface DomainBitSet<T>
    
    Specified by:
    
    spliterator in interface Iterable<T>
    
    Returns:
    
    a Spliterator over the elements in this collection
    
    See Also:
    
    Collection.spliterator()
  - toBigInteger
```
public BigInteger toBigInteger()
```
    Description copied from interface: DomainBitSet
    
    A representation of the elements in this set as a BigInteger.
    
    Specified by:
    
    toBigInteger in interface DomainBitSet<T>
    
    Returns:
    
    The bit mask as a BigInteger.
  - toBitSet
```
public BitSet toBitSet()
```
    Description copied from interface: DomainBitSet
    
    A representation of the elements in this set as a BitSet.
    
    Specified by:
    
    toBitSet in interface DomainBitSet<T>
    
    Returns:
    
    The set as a BitSet.
  - toLong
```
public long toLong()
```
    Description copied from interface: DomainBitSet
    
    A representation of the elements in this set as a long.
    
    Specified by:
    
    toLong in interface DomainBitSet<T>
    
    Returns:
    
    The set as a long.
  - toSet
```
public Set<T> toSet()
```
    Description copied from interface: DomainBitSet
    
    A regular set, with no defined domain. Note that the returned set can be compared to other regular sets, which this always returns false for other sets without a domain.
    
    Specified by:
    
    toSet in interface DomainBitSet<T>
    
    Returns:
    
    A set, without the domain.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - union
```
public DomainBitSet<T> union(BigInteger mask)
```
    Description copied from interface: DomainBitSet
    
    The union of this set and a set represented by a BitSet.
    Note: A fast version for BigInteger.ZERO should exist for each implementation!
    
    Specified by:
    
    union in interface DomainBitSet<T>
    
    Parameters:
    
    mask - A BitSet representing another set.
    
    Returns:
    
    The union of this set and the given set.
  - union
```
public DomainBitSet<T> union(BitSet s)
```
    Description copied from interface: DomainBitSet
    
    The union of this set and a set represented by a BitSet.
    
    Specified by:
    
    union in interface DomainBitSet<T>
    
    Parameters:
    
    s - A BitSet representing another set.
    
    Returns:
    
    The union of this set and the given set.
  - union
```
public DomainBitSet<T> union(Iterable<T> s)
```
    Description copied from interface: DomainBitSet
    
    The union of this set and a set represented by an iterable collection.
    
    Specified by:
    
    union in interface DomainBitSet<T>
    
    Parameters:
    
    s - An Iterable representing another set.
    
    Returns:
    
    The union of this set and the given set.
  - union
```
public DomainBitSet<T> union(long mask)
                      throws IllegalArgumentException
```
    Description copied from interface: DomainBitSet
    
    The union of this set and a set represented by a bit mask.
    
    Specified by:
    
    union in interface DomainBitSet<T>
    
    Parameters:
    
    mask - A bit mask representing another set.
    
    Returns:
    
    The union of this set and the given set.
    
    Throws:
    
    IllegalArgumentException - If the domain contains less than 64 elements then some long values are illegal.
  - unionVarArgs
```
public DomainBitSet<T> unionVarArgs(T... elements)
```
    Description copied from interface: DomainBitSet
    
    The union of this set and a set represented by an array (varargs). The name is different so that it is unambiguous.
    
    Specified by:
    
    unionVarArgs in interface DomainBitSet<T>
    
    Parameters:
    
    elements - A set as an array. Duplicates are ignored. Must not be nor contain null.
    
    Returns:
    
    The union of this and the given set.
    
    See Also:
    
    DomainBitSet.union(Iterable)
  - zipWithPosition
```
public Stream<Pair<Object,Integer,T>> zipWithPosition()
```
    Description copied from interface: DomainBitSet
    
    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.
    
    Specified by:
    
    zipWithPosition in interface DomainBitSet<T>
    
    Returns:
    
    A stream of elements and their position.
    
    See Also:
    
    BitSetUtilities.toTreeMap(), DomainBitSet.getElement(int)

Class SmallDomainBitSet<T>

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface ch.claude_martin.enumbitset.DomainBitSet

Methods inherited from interface java.lang.Iterable

Method Detail

allOf

allOf

noneOf

noneOf

of

of

of

clone

complement

equals

getBit

getDomain

hashCode

intersect

intersect

intersect

intersect

intersectVarArgs

isEmpty

iterator

minus

minus

minus

minus

minusVarArgs

ofEqualElements

powerset

powerset

size

spliterator

toBigInteger

toBitSet

toLong

toSet

toString

union

union

union

union

unionVarArgs

zipWithPosition