aboutsummaryrefslogtreecommitdiff
path: root/src/interfaces/randomization.hpp
blob: 211360e56b4f2d4ba2f238cc515839f7b701e0c9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
#pragma once

#include <memory>

// NOLINTNEXTLINE(cppcoreguidelines-special-member-functions)
class ISeedGenerator
{
public:
	virtual ~ISeedGenerator() noexcept = default;

	[[nodiscard]] virtual uint32_t random_seed() const noexcept = 0;
};

using ISeedGeneratorFactory = std::shared_ptr<ISeedGenerator> (*)();

// NOLINTNEXTLINE(cppcoreguidelines-special-member-functions)
class IRandomNumberGenerator
{
public:
	virtual ~IRandomNumberGenerator() noexcept = default;

	/**
	 * Returns a number in the range of a to b.
	 *
	 * @param a A number lower than b
	 * @param b A number greater than a
	 */
	[[nodiscard]] virtual uint32_t in_range(const uint32_t &a,
											const uint32_t &b) const noexcept = 0;
};

using IRandomNumberGeneratorFactory =
	std::shared_ptr<IRandomNumberGenerator> (*)(const uint32_t &seed);