rust/lfprng/src/lib.rs
author unC0Rr
Sat, 18 Jan 2025 16:55:04 +0100
changeset 16086 106674bb21b1
parent 15931 9b73594ac986
child 16101 a4cbc6926439
permissions -rw-r--r--
Revert the idea of using prime number in hedgewars prng
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
15931
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
     1
use rand::{Error, RngCore, SeedableRng};
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
     2
13910
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
     3
pub struct LaggedFibonacciPRNG {
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
     4
    circular_buffer: [u32; 64],
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
     5
    index: usize,
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
     6
}
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
     7
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
     8
impl LaggedFibonacciPRNG {
14048
cef0c685fda8 make useful stuff public
alfadur
parents: 13956
diff changeset
     9
    pub fn new(init_values: &[u8]) -> Self {
15931
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
    10
        let mut buf = [0xa98765; 64];
13910
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    11
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    12
        for i in 0..std::cmp::min(init_values.len(), 54) {
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    13
            buf[i] = init_values[i] as u32;
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    14
        }
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    15
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    16
        let mut prng = Self {
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    17
            circular_buffer: buf,
16086
106674bb21b1 Revert the idea of using prime number in hedgewars prng
unC0Rr
parents: 15931
diff changeset
    18
            index: 0,
13910
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    19
        };
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    20
15136
de32299de704 Add 'discard' method for lfprng
unc0rr
parents: 14173
diff changeset
    21
        prng.discard(2048);
13910
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    22
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    23
        prng
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    24
    }
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    25
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    26
    #[inline]
15136
de32299de704 Add 'discard' method for lfprng
unc0rr
parents: 14173
diff changeset
    27
    pub fn discard(&mut self, count: usize) {
de32299de704 Add 'discard' method for lfprng
unc0rr
parents: 14173
diff changeset
    28
        for _i in 0..count {
de32299de704 Add 'discard' method for lfprng
unc0rr
parents: 14173
diff changeset
    29
            self.get_next();
de32299de704 Add 'discard' method for lfprng
unc0rr
parents: 14173
diff changeset
    30
        }
de32299de704 Add 'discard' method for lfprng
unc0rr
parents: 14173
diff changeset
    31
    }
de32299de704 Add 'discard' method for lfprng
unc0rr
parents: 14173
diff changeset
    32
de32299de704 Add 'discard' method for lfprng
unc0rr
parents: 14173
diff changeset
    33
    #[inline]
14050
259175ab7e8c hide get_next back
alfadur
parents: 14048
diff changeset
    34
    fn get_next(&mut self) -> u32 {
13910
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    35
        self.index = (self.index + 1) & 0x3f;
15931
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
    36
        let next_value = self.circular_buffer[(self.index + 40) & 0x3f]
16086
106674bb21b1 Revert the idea of using prime number in hedgewars prng
unC0Rr
parents: 15931
diff changeset
    37
            .wrapping_add(self.circular_buffer[(self.index + 9) & 0x3f]);
15931
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
    38
16086
106674bb21b1 Revert the idea of using prime number in hedgewars prng
unC0Rr
parents: 15931
diff changeset
    39
        self.circular_buffer[self.index] = next_value;
13910
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    40
16086
106674bb21b1 Revert the idea of using prime number in hedgewars prng
unC0Rr
parents: 15931
diff changeset
    41
        next_value
13910
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    42
    }
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    43
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    44
    #[inline]
14048
cef0c685fda8 make useful stuff public
alfadur
parents: 13956
diff changeset
    45
    pub fn get_random(&mut self, modulo: u32) -> u32 {
13910
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    46
        self.get_next();
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    47
        self.get_next() % modulo
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    48
    }
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    49
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    50
    #[inline]
14048
cef0c685fda8 make useful stuff public
alfadur
parents: 13956
diff changeset
    51
    pub fn add_randomness(&mut self, value: u32) {
13910
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    52
        self.index = (self.index + 1) & 0x3f;
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    53
        self.circular_buffer[self.index] ^= value;
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    54
    }
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    55
}
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    56
13925
3f0576157749 Implement Iterator trait for LaggedFibonacciPRNG
unc0rr
parents: 13910
diff changeset
    57
impl Iterator for LaggedFibonacciPRNG {
3f0576157749 Implement Iterator trait for LaggedFibonacciPRNG
unc0rr
parents: 13910
diff changeset
    58
    type Item = u32;
3f0576157749 Implement Iterator trait for LaggedFibonacciPRNG
unc0rr
parents: 13910
diff changeset
    59
13956
75eaf7c71789 Introduce integral-geometry crate, implement LinePoints iterator
unc0rr
parents: 13925
diff changeset
    60
    fn next(&mut self) -> Option<Self::Item> {
13925
3f0576157749 Implement Iterator trait for LaggedFibonacciPRNG
unc0rr
parents: 13910
diff changeset
    61
        self.get_next();
3f0576157749 Implement Iterator trait for LaggedFibonacciPRNG
unc0rr
parents: 13910
diff changeset
    62
        Some(self.get_next())
3f0576157749 Implement Iterator trait for LaggedFibonacciPRNG
unc0rr
parents: 13910
diff changeset
    63
    }
3f0576157749 Implement Iterator trait for LaggedFibonacciPRNG
unc0rr
parents: 13910
diff changeset
    64
}
3f0576157749 Implement Iterator trait for LaggedFibonacciPRNG
unc0rr
parents: 13910
diff changeset
    65
15931
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
    66
impl RngCore for LaggedFibonacciPRNG {
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
    67
    fn next_u32(&mut self) -> u32 {
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
    68
        self.get_next().wrapping_add(self.get_next())
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
    69
    }
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
    70
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
    71
    fn next_u64(&mut self) -> u64 {
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
    72
        ((self.next_u32() as u64) << 32) | self.next_u32() as u64
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
    73
    }
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
    74
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
    75
    fn fill_bytes(&mut self, dest: &mut [u8]) {
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
    76
        dest.iter_mut().for_each(|x| *x = self.next_u32() as u8);
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
    77
    }
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
    78
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
    79
    fn try_fill_bytes(&mut self, dest: &mut [u8]) -> Result<(), Error> {
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
    80
        Ok(self.fill_bytes(dest))
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
    81
    }
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
    82
}
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
    83
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
    84
impl SeedableRng for LaggedFibonacciPRNG {
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
    85
    type Seed = [u8; 32];
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
    86
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
    87
    fn from_seed(seed: Self::Seed) -> Self {
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
    88
        LaggedFibonacciPRNG::new(&seed)
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
    89
    }
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
    90
}
9b73594ac986 Update lfprng for better distribution, make it conform 'rand' package traits
unC0Rr
parents: 15136
diff changeset
    91
13910
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    92
#[cfg(test)]
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    93
#[test]
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    94
fn compatibility() {
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    95
    let mut prng = LaggedFibonacciPRNG::new("{052e2aee-ce41-4720-97bd-559a413bf866}".as_bytes());
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
    96
16086
106674bb21b1 Revert the idea of using prime number in hedgewars prng
unC0Rr
parents: 15931
diff changeset
    97
    assert_eq!(prng.get_random(1000), 145);
106674bb21b1 Revert the idea of using prime number in hedgewars prng
unC0Rr
parents: 15931
diff changeset
    98
    assert_eq!(prng.get_random(1000000), 385411);
106674bb21b1 Revert the idea of using prime number in hedgewars prng
unC0Rr
parents: 15931
diff changeset
    99
    assert_eq!(prng.get_random(0xffffffff), 3099784309);
13910
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
   100
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
   101
    prng.add_randomness(123);
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
   102
16086
106674bb21b1 Revert the idea of using prime number in hedgewars prng
unC0Rr
parents: 15931
diff changeset
   103
    for _ in 0..=100000 {
13910
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
   104
        prng.get_random(2);
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
   105
    }
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
   106
16086
106674bb21b1 Revert the idea of using prime number in hedgewars prng
unC0Rr
parents: 15931
diff changeset
   107
    assert_eq!(prng.get_random(0xffffffff), 633923935);
13910
b6c35ac1c5ba Implement lagged Fibonacci PRNG in rust, compatible with hwengine
unc0rr
parents:
diff changeset
   108
}