1

/* $Id$ */

     2

     3

/** @file random_func.h */

     4

     5

#ifndef RANDOM_FUNC_HPP

     6

#define RANDOM_FUNC_HPP

     7

     8

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

     9

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

    10

 *

    11

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

    12

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

    13

 *  is to help finding desync problems.

    14

 *

    15

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

    16

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

    17

    18

//#define RANDOM_DEBUG

    19

    20

    21

// Enable this to produce higher quality random numbers.

    22

// Doesn't work with network yet.

    23

// #define MERSENNE_TWISTER

    24

    25

void SetRandomSeed(uint32 seed);

    26

#ifdef RANDOM_DEBUG

    27

	#define Random() DoRandom(__LINE__, __FILE__)

    28

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

    29

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

    30

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

    31

#else

    32

	uint32 Random();

    33

	uint RandomRange(uint max);

    34

#endif

    35

    36

uint32 InteractiveRandom(); // Used for random sequences that are not the same on the other end of the multiplayer link

    37

uint InteractiveRandomRange(uint max);

    38

    39

/**

    40

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

    41

 *

    42

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

    43

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

    44

 *

    45

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

    46

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

    47

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

    48

 *

    49

 * @param a The numerator of the fraction

    50

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

    51

 * @param r The given randomize-number

    52

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

    53

 */

    54

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

    55

{

    56

	assert(b != 0);

    57

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

    58

}

    59

    60

/**

    61

 * Flips a coin with a given probability.

    62

 *

    63

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

    64

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

    65

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

    66

 *

    67

 * @see Chance16I()

    68

 * @param a The numerator of the fraction

    69

 * @param b The denominator of the fraction

    70

 * @return True in (a/b) percent

    71

 */

    72

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

    73

{

    74

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

    75

}

    76

    77

/**

    78

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

    79

 *

    80

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

    81

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

    82

 *

    83

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

    84

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

    85

 *

    86

 * @see Chance16I()

    87

 * @param a The numerator of the fraction

    88

 * @param b The denominator of the fraction

    89

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

    90

 * @return True in (a/b) percent

    91

 */

    92

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

    93

{

    94

	r = Random();

    95

	return Chance16I(a, b, r);

    96

}

    97

    98

#endif /* RANDOM_FUNC_HPP */