libcruft-util/test/rand/buckets.cpp

#include <cruft/util/rand/xorshift.hpp>
#include <cruft/util/rand/lcg.hpp>
#include <cruft/util/rand/mwc64x.hpp>
#include <cruft/util/rand/pcg.hpp>
#include <cruft/util/rand/rdrand.hpp>
#include <cruft/util/rand/system.hpp>
#include <cruft/util/rand/xoshiro.hpp>
#include <cruft/util/rand/splitmix64.hpp>

#include <cruft/util/tap.hpp>
#include <cruft/util/maths.hpp>
#include <cruft/util/types/string.hpp>
#include <cruft/util/introspection/name.hpp>


/// //////////////////////////////////////////////////////////////////////////////
/// Check that outputs from a UniformRandomBitGenerator are roughly divisible
/// between a number of fixed width buckets.
///
/// This is not anything close to a strict statistical test. It is more aimed
/// at link testing and basic functionality verification within a small
/// resource footprint (ie, fast unit testing).
template <typename GeneratorT, typename ...Args>
static void
test_buckets (cruft::TAP::logger &tap, Args&& ...args)
{
    constexpr unsigned BUCKET_BITS  = 8u;
    constexpr size_t   BUCKET_COUNT = 1u << BUCKET_BITS;
    constexpr unsigned EXPECTED     = 1024u;
    constexpr unsigned ITERATIONS = BUCKET_COUNT * EXPECTED;

    GeneratorT gen (std::forward<Args> (args)...);
    std::uniform_int_distribution<int> dist (0, BUCKET_COUNT - 1);

    unsigned buckets[BUCKET_COUNT] = {};
    for (unsigned i = 0; i < ITERATIONS; ++i)
        ++buckets[dist (gen)];

    tap.expect (
        std::find_if (std::cbegin (buckets),
                      std::cend   (buckets),
                      [] (auto v) { return v < EXPECTED * 7 / 8; }) == std::cend (buckets),
        "bucket counts for {:s}", cruft::introspection::name::full<GeneratorT> ()
    );
}


///////////////////////////////////////////////////////////////////////////////
int
main (int,char**)
{
    cruft::TAP::logger tap;

    test_buckets<cruft::rand::splitmix64> (tap, 0x1234u);
    test_buckets<cruft::rand::xoshiro256plusplus> (tap, 0x1234u);
    test_buckets<cruft::rand::xorshift<uint32_t>> (tap, 0x1234u);
    test_buckets<cruft::rand::xorshift<uint64_t>> (tap, 0x1234u);
    test_buckets<cruft::rand::lcg_t> (tap, 0x1234u);
    test_buckets<cruft::rand::mwc64x> (tap, 0x1234u);
    test_buckets<cruft::rand::pcg_xsh_rr<>> (tap, 0x1234u);
    test_buckets<cruft::rand::system> (tap);
    test_buckets<cruft::rand::rdrand> (tap);

    return tap.status ();
}