forked from libtcod/python-tcod
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathrandom.py
More file actions
138 lines (112 loc) · 4.37 KB
/
random.py
File metadata and controls
138 lines (112 loc) · 4.37 KB
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
"""
Usually it's recommend to the Python's standard library `random` module
instead of this one.
However, you will need to use these generators to get deterministic results
from the :any:`Noise` and :any:`BSP` classes.
"""
import random
from typing import Any, Hashable, Optional
from tcod.loader import ffi, lib
import tcod.constants
MERSENNE_TWISTER = tcod.constants.RNG_MT
COMPLEMENTARY_MULTIPLY_WITH_CARRY = tcod.constants.RNG_CMWC
MULTIPLY_WITH_CARRY = tcod.constants.RNG_CMWC
class Random(object):
"""The libtcod random number generator.
`algorithm` defaults to Mersenne Twister, it can be one of:
* tcod.random.MERSENNE_TWISTER
* tcod.random.MULTIPLY_WITH_CARRY
`seed` is a 32-bit number or any Python hashable object like a string.
Using the same seed will cause the generator to return deterministic
values. The default `seed` of None will generate a random seed instead.
Attributes:
random_c (CData): A cffi pointer to a TCOD_random_t object.
.. versionchanged:: 9.1
Added `tcod.random.MULTIPLY_WITH_CARRY` constant.
`algorithm` parameter now defaults to `tcod.random.MERSENNE_TWISTER`.
"""
def __init__(
self,
algorithm: int = MERSENNE_TWISTER,
seed: Optional[Hashable] = None,
):
"""Create a new instance using this algorithm and seed."""
if seed is None:
seed = random.getrandbits(32)
self.random_c = ffi.gc(
ffi.cast(
"mersenne_data_t*",
lib.TCOD_random_new_from_seed(
algorithm, hash(seed) % (1 << 32)
),
),
lib.TCOD_random_delete,
)
@classmethod
def _new_from_cdata(cls, cdata: Any) -> "Random":
"""Return a new instance encapsulating this cdata."""
self = object.__new__(cls) # type: "Random"
self.random_c = cdata
return self
def randint(self, low: int, high: int) -> int:
"""Return a random integer within the linear range: low <= n <= high.
Args:
low (int): The lower bound of the random range.
high (int): The upper bound of the random range.
Returns:
int: A random integer.
"""
return int(lib.TCOD_random_get_i(self.random_c, low, high))
def uniform(self, low: float, high: float) -> float:
"""Return a random floating number in the range: low <= n <= high.
Args:
low (float): The lower bound of the random range.
high (float): The upper bound of the random range.
Returns:
float: A random float.
"""
return float(lib.TCOD_random_get_double(self.random_c, low, high))
def guass(self, mu: float, sigma: float) -> float:
"""Return a random number using Gaussian distribution.
Args:
mu (float): The median returned value.
sigma (float): The standard deviation.
Returns:
float: A random float.
"""
return float(
lib.TCOD_random_get_gaussian_double(self.random_c, mu, sigma)
)
def inverse_guass(self, mu: float, sigma: float) -> float:
"""Return a random Gaussian number using the Box-Muller transform.
Args:
mu (float): The median returned value.
sigma (float): The standard deviation.
Returns:
float: A random float.
"""
return float(
lib.TCOD_random_get_gaussian_double_inv(self.random_c, mu, sigma)
)
def __getstate__(self) -> Any:
"""Pack the self.random_c attribute into a portable state."""
state = self.__dict__.copy()
state["random_c"] = {
"algo": self.random_c.algo,
"distribution": self.random_c.distribution,
"mt": list(self.random_c.mt),
"cur_mt": self.random_c.cur_mt,
"Q": list(self.random_c.Q),
"c": self.random_c.c,
"cur": self.random_c.cur,
}
return state
def __setstate__(self, state: Any) -> None:
"""Create a new cdata object with the stored paramaters."""
try:
cdata = state["random_c"]
except KeyError: # old/deprecated format
cdata = state["cdata"]
del state["cdata"]
state["random_c"] = ffi.new("mersenne_data_t*", cdata)
self.__dict__.update(state)