-
Notifications
You must be signed in to change notification settings - Fork 6
/
traits.rs
307 lines (289 loc) · 9.78 KB
/
traits.rs
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
use crate::*;
use std::{fmt::Debug, ops::RangeBounds};
#[cfg(feature = "rand")]
use turborand::prelude::RandBorrowed;
/// A trait for applying to [`Component`]s and Resources that wrap a [`TurboCore`] RNG source.
///
/// It provides a threadsafe layer to access the underlying [`TurboCore`] source, which it achieves
/// via only exposing it through a `&mut` reference. This then communicates to the ECS to never schedule
/// systems that access the same overlapping components more than one at a time. Therefore, only one
/// system at a any given time can access a `&mut` referenced [`Component`], ensuring that it is then
/// threadsafe.
///
/// The trait requires one to implement [`DelegatedRng::get_mut`] as the method that underpins the means
/// by which one interacts with the [`TurboCore`] RNG. It also then enables a variety of delegated methods
/// from the [`TurboRand`] trait to be accessed directly under a `&mut self` method. However, this is
/// not always the most ergonomic way to use the RNG, so getting to the inner [`TurboCore`] source via
/// [`DelegatedRng::get_mut`] is the other manner to use the RNG within a system, giving access to
/// `&self` methods of [`TurboRand`].
pub trait DelegatedRng
where
Self::Source: Default
+ Debug
+ Clone
+ PartialEq
+ TurboCore
+ GenCore
+ TurboRand
+ SeededCore
+ ForkableCore,
{
/// The [`TurboCore`] instance that provides the RNG source for the trait. Sources need to implement
/// [`Default`], [`Debug`] (ensuring it does not leak internal state), [`Clone`] and [`PartialEq`], as
/// well as [`SeededCore`], [`GenCore`] and [`ForkableCore`]. [`TurboRand`] is an auto-trait, and is
/// implemented automatically to anything that implements [`TurboCore`].
type Source;
/// Returns the internal [`TurboRand`] reference. Useful
/// for working directly with the internal [`TurboRand`], such as
/// needing to pass the [`TurboRand`] into iterators.
///
/// # Example
/// ```
/// use bevy::prelude::*;
/// use bevy_turborand::prelude::*;
/// use std::iter::repeat_with;
///
/// fn contrived_random_actions(mut q_rand: Query<&mut RngComponent>) {
/// for mut rand in q_rand.iter_mut() {
/// let rand = rand.get_mut(); // Important to shadow the rand mut reference into being an immutable `Rng` one.
///
/// // Now the `TurboRand` source can be borrowed in multiple places in the iterator without issue.
/// let output: Vec<f64> = repeat_with(|| rand.f64()).take(5).filter(|&val| rand.chance(val)).collect();
///
/// println!("Received random values: {:?}", output);
/// }
/// }
/// ```
fn get_mut(&mut self) -> &mut Self::Source;
/// Forks the [`DelegatedRng`] source with a random seed/state, based on the original
/// source's seed. Delegated version of [`ForkableCore::fork`].
#[inline]
#[must_use]
fn fork(&mut self) -> Self::Source {
self.get_mut().fork()
}
/// Reseeds the [`DelegatedRng`] with a new seed/state, resolving to the
/// seed type of the underlying [`SeededCore`] instance.
#[inline]
fn reseed(&mut self, seed: <Self::Source as SeededCore>::Seed) {
self.get_mut().reseed(seed);
}
/// Return a compatibility shim for working with crates from the `rand`
/// ecosystem.
#[cfg(feature = "rand")]
#[cfg_attr(docsrs, doc(cfg(feature = "rand")))]
#[inline]
fn as_rand(&mut self) -> RandBorrowed<'_, Self::Source> {
RandBorrowed::from(self.get_mut())
}
delegate_rng_trait!(
u128,
u128,
impl RangeBounds<u128>,
"Delegated [`TurboRand::u128`] method from [`TurboRand`]."
);
delegate_rng_trait!(
u64,
u64,
impl RangeBounds<u64>,
"Delegated [`TurboRand::u64`] method from [`TurboRand`]."
);
delegate_rng_trait!(
u32,
u32,
impl RangeBounds<u32>,
"Delegated [`TurboRand::u32`] method from [`TurboRand`]."
);
delegate_rng_trait!(
u16,
u16,
impl RangeBounds<u16>,
"Delegated [`TurboRand::u16`] method from [`TurboRand`]."
);
delegate_rng_trait!(
u8,
u8,
impl RangeBounds<u8>,
"Delegated [`TurboRand::u8`] method from [`TurboRand`]."
);
delegate_rng_trait!(
i128,
i128,
impl RangeBounds<i128>,
"Delegated [`TurboRand::i128`] method from [`TurboRand`]."
);
delegate_rng_trait!(
i64,
i64,
impl RangeBounds<i64>,
"Delegated [`TurboRand::i64`] method from [`TurboRand`]."
);
delegate_rng_trait!(
i32,
i32,
impl RangeBounds<i32>,
"Delegated [`TurboRand::i32`] method from [`TurboRand`]."
);
delegate_rng_trait!(
i16,
i16,
impl RangeBounds<i16>,
"Delegated [`TurboRand::i16`] method from [`TurboRand`]."
);
delegate_rng_trait!(
i8,
i8,
impl RangeBounds<i8>,
"Delegated [`TurboRand::i8`] method from [`TurboRand`]."
);
delegate_rng_trait!(
usize,
usize,
impl RangeBounds<usize>,
"Delegated [`TurboRand::usize`] method from [`TurboRand`]."
);
delegate_rng_trait!(
isize,
isize,
impl RangeBounds<isize>,
"Delegated [`TurboRand::isize`] method from [`TurboRand`]."
);
delegate_rng_trait!(
index,
usize,
impl RangeBounds<usize>,
"Delegated [`TurboRand::index`] method from [`TurboRand`]."
);
delegate_rng_trait!(
chance,
bool,
f64,
"Delegated [`TurboRand::chance`] method from [`TurboRand`]."
);
delegate_rng_trait!(
char,
char,
impl RangeBounds<char>,
"Delegated [`TurboRand::char`] method from [`TurboRand`]."
);
delegate_rng_trait!(
digit,
char,
u8,
"Delegated [`TurboRand::digit`] method from [`TurboRand`]."
);
delegate_rng_trait!(
alphabetic,
char,
"Delegated [`TurboRand::alphabetic`] method from [`TurboRand`]."
);
delegate_rng_trait!(
alphanumeric,
char,
"Delegated [`TurboRand::alphanumeric`] method from [`TurboRand`]."
);
delegate_rng_trait!(
lowercase,
char,
"Delegated [`TurboRand::lowercase`] method from [`TurboRand`]."
);
delegate_rng_trait!(
uppercase,
char,
"Delegated [`TurboRand::uppercase`] method from [`TurboRand`]."
);
delegate_rng_trait!(
bool,
bool,
"Delegated [`TurboRand::bool`] method from [`TurboRand`]."
);
delegate_rng_trait!(
f64,
f64,
"Delegated [`TurboRand::f64`] method from [`TurboRand`]."
);
delegate_rng_trait!(
f32,
f32,
"Delegated [`TurboRand::f32`] method from [`TurboRand`]."
);
delegate_rng_trait!(
f64_normalized,
f64,
"Delegated [`TurboRand::f64_normalized`] method from [`TurboRand`]."
);
delegate_rng_trait!(
f32_normalized,
f32,
"Delegated [`TurboRand::f32_normalized`] method from [`TurboRand`]."
);
/// Delegated [`TurboCore::fill_bytes`] method from [`TurboCore`].
#[inline]
fn fill_bytes(&mut self, buffer: &mut [u8]) {
self.get_mut().fill_bytes(buffer);
}
/// Delegated [`TurboRand::shuffle`] method from [`TurboRand`].
#[inline]
fn shuffle<T>(&mut self, slice: &mut [T]) {
self.get_mut().shuffle(slice);
}
/// Delegated [`TurboRand::partial_shuffle`] method from [`TurboRand`].
#[inline]
fn partial_shuffle<'a, T>(
&mut self,
slice: &'a mut [T],
amount: usize,
) -> (&'a mut [T], &'a mut [T]) {
self.get_mut().partial_shuffle(slice, amount)
}
/// Delegated [`TurboRand::sample`] method from [`TurboRand`].
#[inline]
fn sample<'a, T>(&mut self, list: &'a [T]) -> Option<&'a T> {
self.get_mut().sample(list)
}
/// Delegated [`TurboRand::sample_iter`] method from [`TurboRand`].
#[inline]
fn sample_iter<T: Iterator>(&mut self, list: T) -> Option<T::Item> {
self.get_mut().sample_iter(list)
}
/// Delegated [`TurboRand::sample_mut`] method from [`TurboRand`].
#[inline]
fn sample_mut<'a, T>(&mut self, list: &'a mut [T]) -> Option<&'a mut T> {
self.get_mut().sample_mut(list)
}
/// Delegated [`TurboRand::sample_multiple`] method from [`TurboRand`].
#[inline]
fn sample_multiple<'a, T>(&mut self, list: &'a [T], amount: usize) -> Vec<&'a T> {
self.get_mut().sample_multiple(list, amount)
}
/// Delegated [`TurboRand::sample_multiple_iter`] method from [`TurboRand`].
#[inline]
fn sample_multiple_iter<T: Iterator>(&mut self, list: T, amount: usize) -> Vec<T::Item> {
self.get_mut().sample_multiple_iter(list, amount)
}
/// Delegated [`TurboRand::sample_multiple_mut`] method from [`TurboRand`].
#[inline]
fn sample_multiple_mut<'a, T>(&mut self, list: &'a mut [T], amount: usize) -> Vec<&'a mut T> {
self.get_mut().sample_multiple_mut(list, amount)
}
/// Delegated [`TurboRand::weighted_sample`] method from [`TurboRand`].
#[inline]
fn weighted_sample<'a, T, F>(&mut self, list: &'a [T], weight_sampler: F) -> Option<&'a T>
where
F: Fn((&T, usize)) -> f64,
{
self.get_mut().weighted_sample(list, weight_sampler)
}
/// Delegated [`TurboRand::weighted_sample_mut`] method from [`TurboRand`].
#[inline]
fn weighted_sample_mut<'a, T, F>(
&mut self,
list: &'a mut [T],
weight_sampler: F,
) -> Option<&'a mut T>
where
F: Fn((&T, usize)) -> f64,
{
self.get_mut().weighted_sample_mut(list, weight_sampler)
}
}