lumiera_/src/lib/random.cpp
Ichthyostega 92bc044e9e Library: consider how to handle randomness in tests
Using random or pseudo-random numbers as input for tests
can be a very effective tool to spot unintended behaviour in
corner cases, and also helps writing more principled test verifications.
However, investigating failures in randomised tests can be challenging.

A well-proven solution is to exploit the **determinism** of pseudo-random-numbers
by documenting a randomly generated seed, that can be re-injected for investigation.

Up to now, most tests rely on the old library function `rand()`, while
at some places already the C++ standard framework for random number generation
is used, packaged into a custom wrapper. Adding adequate support for
documented seed values seems to be easy to achieve, after switching
existing usages of `rand()` to a suitable drop-in replacement.

After some consideration, I decided ''against'' wiring random generator instances
explicitly, while allowing to do so on occasion, when necessary. Thus
the planned seeding mechanism will rather re-seed a ''implicit default''
generator, which could then be used to construct explicit generator instances
when required (e.g. for multithreaded tests)

As a starting point, this changeset replaces the `randomise()` API call
by a direct access to the ''reseeding functionality'' exposed by the
C++ framework and all default generators. Since we already provide a
dedicated static instance of the plattform entropy source, re-randomisation
can be achieved by seeding from there.

NOTE: there was extended debate in the net, questioning the viability
of the `std::random_seq` -- these arguments, while valid from a theoretical
point of view, seem rather moot when placed into a practical context,
where even 2^32 different generation-paths(cycles) are more than enough
to provide sufficient diffusion of results (unless the goal is really to
engage into Monte-Carlo simulations for scientific research or large model
simulations).

Notable most of the more catchy reprovals raised by Melissa O'Neill
have been refuted by experts of the field, even while being still propagated
at various places in the net, often combined with promoting PCG-Random.
2024-11-10 03:25:45 +01:00

91 lines
2.2 KiB
C++

/*
random.cpp - storage and implementation for random number framework
Copyright (C) Lumiera.org
2024, Hermann Vosseler <Ichthyostega@web.de>
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of
the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
* *****************************************************/
/** @file random.cpp
** Implementation details and common storage for random number generation.
** @todo 3/2024 work out how some executions or performances are configured reproducibly.
*/
#include "lib/random.hpp"
#include <string>
using std::string;
namespace lib {
namespace {
const string ENTROPY_SOURCE_SPEC{"/dev/random"};
class EntropyNucleus
: public SeedNucleus
{
std::random_device entropySource_;
uint64_t
getSeed() override
{
return entropySource_();
}
public:
EntropyNucleus(string const& SPEC)
: entropySource_{SPEC}
{ }
};
class EternalNucleus
: public SeedNucleus
{
uint64_t
getSeed() override
{
return LIFE_AND_UNIVERSE_4EVER;
}
};
/** static global entropy source instance */
EntropyNucleus entropyNucleus{ENTROPY_SOURCE_SPEC};
/// @todo this one should somehow be configurable
EternalNucleus eternalNucleus;
}
SeedNucleus::~SeedNucleus() { }
Random defaultGen{eternalNucleus};
Random entropyGen{entropyNucleus};
void
randomiseRandomness()
{
entropyGen.reseed(entropyNucleus);
defaultGen.reseed(entropyNucleus);
}
} // namespace lib