1

/* $Id$ */

     2

     3

/** @file random_func.hpp Pseudo random number generator. */

     4

     5

#ifndef RANDOM_FUNC_HPP

     6

#define RANDOM_FUNC_HPP

     7

     8

#if defined(__APPLE__)

     9

	/* Apple already has Random declared */

    10

	#define Random OTTD_Random

    11

#endif /* __APPLE__ */

    12

    13

/**************

    14

 * Warning: DO NOT enable this unless you understand what it does

    15

 *

    16

 * If enabled, in a network game all randoms will be dumped to the

    17

 *  stdout if the first client joins (or if you are a client). This

    18

 *  is to help finding desync problems.

    19

 *

    20

 * Warning: DO NOT enable this unless you understand what it does

    21

 **************/

    22

    23

//#define RANDOM_DEBUG

    24

    25

    26

/**

    27

 * Structure to encapsulate the pseudo random number generators.

    28

 */

    29

struct Randomizer {

    30

	/** The state of the randomizer */

    31

	uint32 state[2];

    32

    33

	/**

    34

	 * Generate the next pseudo random number

    35

	 * @return the random number

    36

	 */

    37

	uint32 Next();

    38

    39

	/**

    40

	 * Generate the next pseudo random number scaled to max

    41

	 * @param max the maximum value of the returned random number

    42

	 * @return the random number

    43

	 */

    44

	uint32 Next(uint16 max);

    45

    46

	/**

    47

	 * (Re)set the state of the random number generator.

    48

	 * @param seed the new state

    49

	 */

    50

	void SetSeed(uint32 seed);

    51

};

    52

extern Randomizer _random; ///< Random used in the game state calculations

    53

extern Randomizer _interactive_random; ///< Random used every else where is does not (directly) influence the game state

    54

    55

void SetRandomSeed(uint32 seed);

    56

#ifdef RANDOM_DEBUG

    57

	#define Random() DoRandom(__LINE__, __FILE__)

    58

	uint32 DoRandom(int line, const char *file);

    59

	#define RandomRange(max) DoRandomRange(max, __LINE__, __FILE__)

    60

	uint DoRandomRange(uint max, int line, const char *file);

    61

#else

    62

	static inline uint32 Random() { return _random.Next(); }

    63

	static inline uint32 RandomRange(uint16 max) { return _random.Next(max); }

    64

#endif

    65

    66

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

    67

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

    68

    69

/**

    70

 * Checks if a given randomize-number is below a given probability.

    71

 *

    72

 * This function is used to check if the given probability by the fraction of (a/b)

    73

 * is greater than low 16 bits of the given randomize-number v.

    74

 *

    75

 * Do not use this function twice on the same random 16 bits as it will yield

    76

 * the same result. One can use a random number for two calls to Chance16I,

    77

 * where one call sends the low 16 bits and the other the high 16 bits.

    78

 *

    79

 * @param a The numerator of the fraction

    80

 * @param b The denominator of the fraction, must of course not be null

    81

 * @param r The given randomize-number

    82

 * @return True if v is less or equals (a/b)

    83

 */

    84

static inline bool Chance16I(const uint a, const uint b, const uint32 r)

    85

{

    86

	assert(b != 0);

    87

	return (uint16)r < (uint16)(((a << 16) + b / 2) / b);

    88

}

    89

    90

/**

    91

 * Flips a coin with a given probability.

    92

 *

    93

 * This macro can be used to get true or false randomized according to a

    94

 * given probability. The parameter a and b create a percent value with

    95

 * (a/b). The macro returns true in (a/b) percent.

    96

 *

    97

 * @see Chance16I()

    98

 * @param a The numerator of the fraction

    99

 * @param b The denominator of the fraction

   100

 * @return True in (a/b) percent

   101

 */

   102

static inline bool Chance16(const uint a, const uint b)

   103

{

   104

	return Chance16I(a, b, Random());

   105

}

   106

   107

/**

   108

 * Flips a coin with a given probability and saves the randomize-number in a variable.

   109

 *

   110

 * This function uses the same parameters as Chance16. The third parameter

   111

 * must be a variable the randomize-number from Random() is saved in.

   112

 *

   113

 * The low 16 bits of r will already be used and can therefor not be passed to

   114

 * Chance16I. One can only send the high 16 bits to Chance16I.

   115

 *

   116

 * @see Chance16I()

   117

 * @param a The numerator of the fraction

   118

 * @param b The denominator of the fraction

   119

 * @param r The variable to save the randomize-number from Random()

   120

 * @return True in (a/b) percent

   121

 */

   122

static inline bool Chance16R(const uint a, const uint b, uint32 &r)

   123

{

   124

	r = Random();

   125

	return Chance16I(a, b, r);

   126

}

   127

   128

#endif /* RANDOM_FUNC_HPP */