de.team33.patterns.arbitrary.mimas.BitGenerator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of arbitrary-mimas Show documentation

Provides classes that support the generation of arbitrary values of virtually any type.

The newest version!

package de.team33.patterns.arbitrary.mimas;

import java.math.BigInteger;

interface BitGenerator {

    /**
     * Returns any non-negative {@link BigInteger} representing a sequence of significant bits of a given length.
     * In other words, the result is any value between zero (inclusive) and 2^length (exclusive).
     * 
     * A typical implementation will return an arbitrary value within the defined bounds, with each possible value
     * being equally probable.
     */
    BigInteger anyBits(final int numBits);
}