Branch data Line data Source code
1 : : /*
2 : : * This file is part of the MicroPython project, http://micropython.org/
3 : : *
4 : : * The MIT License (MIT)
5 : : *
6 : : * Copyright (c) 2016 Paul Sokolovsky
7 : : *
8 : : * Permission is hereby granted, free of charge, to any person obtaining a copy
9 : : * of this software and associated documentation files (the "Software"), to deal
10 : : * in the Software without restriction, including without limitation the rights
11 : : * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 : : * copies of the Software, and to permit persons to whom the Software is
13 : : * furnished to do so, subject to the following conditions:
14 : : *
15 : : * The above copyright notice and this permission notice shall be included in
16 : : * all copies or substantial portions of the Software.
17 : : *
18 : : * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 : : * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 : : * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 : : * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 : : * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 : : * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 : : * THE SOFTWARE.
25 : : */
26 : :
27 : : #include <assert.h>
28 : : #include <string.h>
29 : :
30 : : #include "py/runtime.h"
31 : :
32 : : #if MICROPY_PY_RANDOM
33 : :
34 : : // Work out if the seed will be set on import or not.
35 : : #if MICROPY_MODULE_BUILTIN_INIT && defined(MICROPY_PY_RANDOM_SEED_INIT_FUNC)
36 : : #define SEED_ON_IMPORT (1)
37 : : #else
38 : : #define SEED_ON_IMPORT (0)
39 : : #endif
40 : :
41 : : // Yasmarang random number generator
42 : : // by Ilya Levin
43 : : // http://www.literatecode.com/yasmarang
44 : : // Public Domain
45 : :
46 : : #if !MICROPY_ENABLE_DYNRUNTIME
47 : : #if SEED_ON_IMPORT
48 : : // If the state is seeded on import then keep these variables in the BSS.
49 : : static uint32_t yasmarang_pad, yasmarang_n, yasmarang_d;
50 : : static uint8_t yasmarang_dat;
51 : : #else
52 : : // Without seed-on-import these variables must be initialised via the data section.
53 : : static uint32_t yasmarang_pad = 0xeda4baba, yasmarang_n = 69, yasmarang_d = 233;
54 : : static uint8_t yasmarang_dat = 0;
55 : : #endif
56 : : #endif
57 : :
58 : 3121 : static uint32_t yasmarang(void) {
59 : 3121 : yasmarang_pad += yasmarang_dat + yasmarang_d * yasmarang_n;
60 : 3121 : yasmarang_pad = (yasmarang_pad << 3) + (yasmarang_pad >> 29);
61 : 3121 : yasmarang_n = yasmarang_pad | 2;
62 : 3121 : yasmarang_d ^= (yasmarang_pad << 31) + (yasmarang_pad >> 1);
63 : 3121 : yasmarang_dat ^= (char)yasmarang_pad ^ (yasmarang_d >> 8) ^ 1;
64 : :
65 : 3121 : return yasmarang_pad ^ (yasmarang_d << 5) ^ (yasmarang_pad >> 18) ^ (yasmarang_dat << 1);
66 : : } /* yasmarang */
67 : :
68 : : // End of Yasmarang
69 : :
70 : : #if MICROPY_PY_RANDOM_EXTRA_FUNCS
71 : :
72 : : // returns an unsigned integer below the given argument
73 : : // n must not be zero
74 : 900 : static uint32_t yasmarang_randbelow(uint32_t n) {
75 : 900 : uint32_t mask = 1;
76 [ + + ]: 2500 : while ((n & mask) < n) {
77 : 1600 : mask = (mask << 1) | 1;
78 : : }
79 : 1655 : uint32_t r;
80 : 1655 : do {
81 : 1655 : r = yasmarang() & mask;
82 [ + + ]: 1655 : } while (r >= n);
83 : 900 : return r;
84 : : }
85 : :
86 : : #endif
87 : :
88 : 670 : static mp_obj_t mod_random_getrandbits(mp_obj_t num_in) {
89 : 670 : mp_int_t n = mp_obj_get_int(num_in);
90 [ + + ]: 670 : if (n > 32 || n < 0) {
91 : 2 : mp_raise_ValueError(MP_ERROR_TEXT("bits must be 32 or less"));
92 : : }
93 [ + + ]: 668 : if (n == 0) {
94 : : return MP_OBJ_NEW_SMALL_INT(0);
95 : : }
96 : 666 : uint32_t mask = ~0;
97 : : // Beware of C undefined behavior when shifting by >= than bit size
98 : 666 : mask >>= (32 - n);
99 : 666 : return mp_obj_new_int_from_uint(yasmarang() & mask);
100 : : }
101 : : static MP_DEFINE_CONST_FUN_OBJ_1(mod_random_getrandbits_obj, mod_random_getrandbits);
102 : :
103 : 22 : static mp_obj_t mod_random_seed(size_t n_args, const mp_obj_t *args) {
104 : 22 : mp_uint_t seed;
105 [ + + + + ]: 22 : if (n_args == 0 || args[0] == mp_const_none) {
106 : : #ifdef MICROPY_PY_RANDOM_SEED_INIT_FUNC
107 : 16 : seed = MICROPY_PY_RANDOM_SEED_INIT_FUNC;
108 : : #else
109 : : mp_raise_ValueError(MP_ERROR_TEXT("no default seed"));
110 : : #endif
111 : : } else {
112 : 6 : seed = mp_obj_get_int_truncated(args[0]);
113 : : }
114 : 22 : yasmarang_pad = (uint32_t)seed;
115 : 22 : yasmarang_n = 69;
116 : 22 : yasmarang_d = 233;
117 : 22 : yasmarang_dat = 0;
118 : 22 : return mp_const_none;
119 : : }
120 : : static MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(mod_random_seed_obj, 0, 1, mod_random_seed);
121 : :
122 : : #if MICROPY_PY_RANDOM_EXTRA_FUNCS
123 : :
124 : 508 : static mp_obj_t mod_random_randrange(size_t n_args, const mp_obj_t *args) {
125 : 508 : mp_int_t start = mp_obj_get_int(args[0]);
126 [ + + ]: 508 : if (n_args == 1) {
127 : : // range(stop)
128 [ + + ]: 102 : if (start > 0) {
129 : 100 : return mp_obj_new_int(yasmarang_randbelow((uint32_t)start));
130 : : } else {
131 : 2 : goto error;
132 : : }
133 : : } else {
134 : 406 : mp_int_t stop = mp_obj_get_int(args[1]);
135 [ + + ]: 406 : if (n_args == 2) {
136 : : // range(start, stop)
137 [ + + ]: 202 : if (start < stop) {
138 : 200 : return mp_obj_new_int(start + yasmarang_randbelow((uint32_t)(stop - start)));
139 : : } else {
140 : 2 : goto error;
141 : : }
142 : : } else {
143 : : // range(start, stop, step)
144 : 204 : mp_int_t step = mp_obj_get_int(args[2]);
145 : 204 : mp_int_t n;
146 [ + + ]: 204 : if (step > 0) {
147 : 102 : n = (stop - start + step - 1) / step;
148 [ + + ]: 102 : } else if (step < 0) {
149 : 100 : n = (stop - start + step + 1) / step;
150 : : } else {
151 : 2 : goto error;
152 : : }
153 [ + + ]: 202 : if (n > 0) {
154 : 200 : return mp_obj_new_int(start + step * yasmarang_randbelow((uint32_t)n));
155 : : } else {
156 : 2 : goto error;
157 : : }
158 : : }
159 : : }
160 : :
161 : 8 : error:
162 : 8 : mp_raise_ValueError(NULL);
163 : : }
164 : : static MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(mod_random_randrange_obj, 1, 3, mod_random_randrange);
165 : :
166 : 302 : static mp_obj_t mod_random_randint(mp_obj_t a_in, mp_obj_t b_in) {
167 : 302 : mp_int_t a = mp_obj_get_int(a_in);
168 : 302 : mp_int_t b = mp_obj_get_int(b_in);
169 [ + + ]: 302 : if (a <= b) {
170 : 300 : return mp_obj_new_int(a + yasmarang_randbelow((uint32_t)(b - a + 1)));
171 : : } else {
172 : 2 : mp_raise_ValueError(NULL);
173 : : }
174 : : }
175 : : static MP_DEFINE_CONST_FUN_OBJ_2(mod_random_randint_obj, mod_random_randint);
176 : :
177 : 102 : static mp_obj_t mod_random_choice(mp_obj_t seq) {
178 : 102 : mp_int_t len = mp_obj_get_int(mp_obj_len(seq));
179 [ + + ]: 102 : if (len > 0) {
180 : 100 : return mp_obj_subscr(seq, mp_obj_new_int(yasmarang_randbelow((uint32_t)len)), MP_OBJ_SENTINEL);
181 : : } else {
182 : 2 : mp_raise_type(&mp_type_IndexError);
183 : : }
184 : : }
185 : : static MP_DEFINE_CONST_FUN_OBJ_1(mod_random_choice_obj, mod_random_choice);
186 : :
187 : : #if MICROPY_PY_BUILTINS_FLOAT
188 : :
189 : : // returns a number in the range [0..1) using Yasmarang to fill in the fraction bits
190 : 400 : static mp_float_t yasmarang_float(void) {
191 : 400 : mp_float_union_t u;
192 : 400 : u.p.sgn = 0;
193 : 400 : u.p.exp = (1 << (MP_FLOAT_EXP_BITS - 1)) - 1;
194 : 400 : if (MP_FLOAT_FRAC_BITS <= 32) {
195 : : u.p.frc = yasmarang();
196 : : } else {
197 : 400 : u.p.frc = ((uint64_t)yasmarang() << 32) | (uint64_t)yasmarang();
198 : : }
199 : 400 : return u.f - 1;
200 : : }
201 : :
202 : 100 : static mp_obj_t mod_random_random(void) {
203 : 100 : return mp_obj_new_float(yasmarang_float());
204 : : }
205 : : static MP_DEFINE_CONST_FUN_OBJ_0(mod_random_random_obj, mod_random_random);
206 : :
207 : 300 : static mp_obj_t mod_random_uniform(mp_obj_t a_in, mp_obj_t b_in) {
208 : 300 : mp_float_t a = mp_obj_get_float(a_in);
209 : 300 : mp_float_t b = mp_obj_get_float(b_in);
210 : 300 : return mp_obj_new_float(a + (b - a) * yasmarang_float());
211 : : }
212 : : static MP_DEFINE_CONST_FUN_OBJ_2(mod_random_uniform_obj, mod_random_uniform);
213 : :
214 : : #endif
215 : :
216 : : #endif // MICROPY_PY_RANDOM_EXTRA_FUNCS
217 : :
218 : : #if SEED_ON_IMPORT
219 : 8 : static mp_obj_t mod_random___init__(void) {
220 : : // This module may be imported by more than one name so need to ensure
221 : : // that it's only ever seeded once.
222 : 8 : static bool seeded = false;
223 [ + - ]: 8 : if (!seeded) {
224 : 8 : seeded = true;
225 : 8 : mod_random_seed(0, NULL);
226 : : }
227 : 8 : return mp_const_none;
228 : : }
229 : : static MP_DEFINE_CONST_FUN_OBJ_0(mod_random___init___obj, mod_random___init__);
230 : : #endif
231 : :
232 : : #if !MICROPY_ENABLE_DYNRUNTIME
233 : : static const mp_rom_map_elem_t mp_module_random_globals_table[] = {
234 : : { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_random) },
235 : : #if SEED_ON_IMPORT
236 : : { MP_ROM_QSTR(MP_QSTR___init__), MP_ROM_PTR(&mod_random___init___obj) },
237 : : #endif
238 : : { MP_ROM_QSTR(MP_QSTR_getrandbits), MP_ROM_PTR(&mod_random_getrandbits_obj) },
239 : : { MP_ROM_QSTR(MP_QSTR_seed), MP_ROM_PTR(&mod_random_seed_obj) },
240 : : #if MICROPY_PY_RANDOM_EXTRA_FUNCS
241 : : { MP_ROM_QSTR(MP_QSTR_randrange), MP_ROM_PTR(&mod_random_randrange_obj) },
242 : : { MP_ROM_QSTR(MP_QSTR_randint), MP_ROM_PTR(&mod_random_randint_obj) },
243 : : { MP_ROM_QSTR(MP_QSTR_choice), MP_ROM_PTR(&mod_random_choice_obj) },
244 : : #if MICROPY_PY_BUILTINS_FLOAT
245 : : { MP_ROM_QSTR(MP_QSTR_random), MP_ROM_PTR(&mod_random_random_obj) },
246 : : { MP_ROM_QSTR(MP_QSTR_uniform), MP_ROM_PTR(&mod_random_uniform_obj) },
247 : : #endif
248 : : #endif
249 : : };
250 : :
251 : : static MP_DEFINE_CONST_DICT(mp_module_random_globals, mp_module_random_globals_table);
252 : :
253 : : const mp_obj_module_t mp_module_random = {
254 : : .base = { &mp_type_module },
255 : : .globals = (mp_obj_dict_t *)&mp_module_random_globals,
256 : : };
257 : :
258 : : MP_REGISTER_EXTENSIBLE_MODULE(MP_QSTR_random, mp_module_random);
259 : : #endif
260 : :
261 : : #endif // MICROPY_PY_RANDOM
|
