File diff r15025:2d23afc43d78 → r15026:ba524394be83
src/core/random_func.hpp
Show inline comments
 
@@ -27,112 +27,111 @@
 
 * Warning: DO NOT enable this unless you understand what it does
 
 **************/
 

	
 
//#define RANDOM_DEBUG
 

	
 

	
 
/**
 
 * Structure to encapsulate the pseudo random number generators.
 
 */
 
struct Randomizer {
 
	/** The state of the randomizer */
 
	uint32 state[2];
 

	
 
	/**
 
	 * Generate the next pseudo random number
 
	 * @return the random number
 
	 */
 
	uint32 Next();
 

	
 
	/**
 
	 * Generate the next pseudo random number scaled to max
 
	 * @param max the maximum value of the returned random number
 
	 * @return the random number
 
	 */
 
	uint32 Next(uint16 max);
 
	uint32 Next(uint32 max);
 

	
 
	/**
 
	 * (Re)set the state of the random number generator.
 
	 * @param seed the new state
 
	 */
 
	void SetSeed(uint32 seed);
 
};
 
extern Randomizer _random; ///< Random used in the game state calculations
 
extern Randomizer _interactive_random; ///< Random used every else where is does not (directly) influence the game state
 

	
 
/** Stores the state of all random number generators */
 
struct SavedRandomSeeds {
 
	Randomizer random;
 
	Randomizer interactive_random;
 
};
 

	
 
/** Saves the current seeds
 
 * @param storage Storage for saving
 
 */
 
static inline void SaveRandomSeeds(SavedRandomSeeds *storage)
 
{
 
	storage->random = _random;
 
	storage->interactive_random = _interactive_random;
 
}
 

	
 
/** Restores previously saved seeds
 
 * @param storage Storage where SaveRandomSeeds() stored th seeds
 
 */
 
static inline void RestoreRandomSeeds(const SavedRandomSeeds &storage)
 
{
 
	_random = storage.random;
 
	_interactive_random = storage.interactive_random;
 
}
 

	
 
void SetRandomSeed(uint32 seed);
 
#ifdef RANDOM_DEBUG
 
	#ifdef __APPLE__
 
		#define OTTD_Random() DoRandom(__LINE__, __FILE__)
 
	#else
 
		#define Random() DoRandom(__LINE__, __FILE__)
 
	#endif
 
	uint32 DoRandom(int line, const char *file);
 
	#define RandomRange(max) DoRandomRange(max, __LINE__, __FILE__)
 
	uint DoRandomRange(uint max, int line, const char *file);
 
	uint32 DoRandomRange(uint32 max, int line, const char *file);
 
#else
 
	static FORCEINLINE uint32 Random()
 
	{
 
		return _random.Next();
 
	}
 

	
 
	static FORCEINLINE uint32 RandomRange(uint max)
 
	static FORCEINLINE uint32 RandomRange(uint32 max)
 
	{
 
		assert(max <= UINT16_MAX);
 
		return _random.Next(max);
 
	}
 
#endif
 

	
 
static FORCEINLINE uint32 InteractiveRandom()
 
{
 
	return _interactive_random.Next();
 
}
 

	
 
static FORCEINLINE uint32 InteractiveRandomRange(uint16 max)
 
static FORCEINLINE uint32 InteractiveRandomRange(uint32 max)
 
{
 
	return _interactive_random.Next(max);
 
}
 

	
 
/**
 
 * Checks if a given randomize-number is below a given probability.
 
 *
 
 * This function is used to check if the given probability by the fraction of (a/b)
 
 * is greater than low 16 bits of the given randomize-number r.
 
 *
 
 * Do not use this function twice on the same random 16 bits as it will yield
 
 * the same result. One can use a random number for two calls to Chance16I,
 
 * where one call sends the low 16 bits and the other the high 16 bits.
 
 *
 
 * @param a The numerator of the fraction
 
 * @param b The denominator of the fraction, must of course not be null
 
 * @param r The given randomize-number
 
 * @return True if the probability given by r is less or equal to (a/b)
 
 */
 
static FORCEINLINE bool Chance16I(const uint a, const uint b, const uint32 r)
 
{
 
	assert(b != 0);
 
	return (((uint16)r * b + b / 2) >> 16) < a;
 
}