File diff r18781:e1de9a06f7cd → r18782:6453522c2154
src/core/random_func.hpp
Show inline comments
 
@@ -72,99 +72,99 @@ static inline void RestoreRandomSeeds(co
 

	
 
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__)
 
	uint32 DoRandomRange(uint32 max, int line, const char *file);
 
#else
 
	static FORCEINLINE uint32 Random()
 
	static inline uint32 Random()
 
	{
 
		return _random.Next();
 
	}
 

	
 
	static FORCEINLINE uint32 RandomRange(uint32 max)
 
	static inline uint32 RandomRange(uint32 max)
 
	{
 
		return _random.Next(max);
 
	}
 
#endif
 

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

	
 
static FORCEINLINE uint32 InteractiveRandomRange(uint32 max)
 
static inline 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)
 
static inline bool Chance16I(const uint a, const uint b, const uint32 r)
 
{
 
	assert(b != 0);
 
	return (((uint16)r * b + b / 2) >> 16) < a;
 
}
 

	
 
/**
 
 * Flips a coin with given probability.
 
 *
 
 * This function returns true with (a/b) probability.
 
 *
 
 * @see Chance16I()
 
 * @param a The nominator of the fraction
 
 * @param b The denominator of the fraction
 
 * @return True with (a/b) probability
 
 */
 
#ifdef RANDOM_DEBUG
 
	#define Chance16(a, b) Chance16I(a, b, DoRandom(__LINE__, __FILE__))
 
#else
 
static FORCEINLINE bool Chance16(const uint a, const uint b)
 
static inline bool Chance16(const uint a, const uint b)
 
{
 
	return Chance16I(a, b, Random());
 
}
 
#endif /* RANDOM_DEBUG */
 

	
 
/**
 
 * Flips a coin with a given probability and saves the randomize-number in a variable.
 
 *
 
 * This function uses the same parameters as Chance16. The third parameter
 
 * must be a variable the randomize-number from Random() is saved in.
 
 *
 
 * The low 16 bits of r will already be used and can therefor not be passed to
 
 * Chance16I. One can only send the high 16 bits to Chance16I.
 
 *
 
 * @see Chance16I()
 
 * @param a The numerator of the fraction
 
 * @param b The denominator of the fraction
 
 * @param r The variable to save the randomize-number from Random()
 
 * @return True in (a/b) percent
 
 */
 
#ifdef RANDOM_DEBUG
 
	#define Chance16R(a, b, r) (r = DoRandom(__LINE__, __FILE__), Chance16I(a, b, r))
 
#else
 
static FORCEINLINE bool Chance16R(const uint a, const uint b, uint32 &r)
 
static inline bool Chance16R(const uint a, const uint b, uint32 &r)
 
{
 
	r = Random();
 
	return Chance16I(a, b, r);
 
}
 
#endif /* RANDOM_DEBUG */
 

	
 
#endif /* RANDOM_FUNC_HPP */