Struct Linear16

pub struct Linear16 { /* private fields */ }

16-bit Galois linear feedback shift register. This generator has an extremely short period of 65535.

Example

use rand_core::{SeedableRng, RngCore};
use lineargen::Linear16;

let mut rng = Linear16::seed_from_u64(1234567);
for _ in 0..100 { rng.next_u32(); }

assert_eq!(1407506474, rng.next_u32());

Implementations

impl Linear16

pub fn clock(&mut self)

Clock the LFSR once without generating a number.

pub fn clock_rev(&mut self)

Clock the LFSR in reverse.

pub fn quick_bool(&mut self) -> bool

Returns true if the least significant bit is one, else returns false. The LFSR is clocked once.

pub fn quick_bool_rev(&mut self) -> bool

Returns true if the most significant bit is one, else returns false. The LFSR is clocked backwards.

pub fn dump_state(&self) -> u16

Returns the current state of the LFSR.

pub fn reverse_state(&mut self)

Reverses the bits of the state, i.e. the least significant bit becomes the most significant one and vice versa.

pub fn inverse_state(&mut self)

Negates the bits of the state.

pub fn get_32bits(&mut self) -> u32

Generates a 32-bit unsigned integer. You might want to use next_u32() from RngCore instead.

pub fn get_32bits_rev(&mut self) -> u32

Generates a 32-bit unsigned integer by clocking the LFSR in reverse (left shift).

Note, that this will not just return the numbers generated with get_32bits() in reverse order.

pub fn get_64bits(&mut self) -> u64

Generates a 64-bit unsigned integer. You might want to use next_u64() from RngCore instead.

pub fn get_64bits_rev(&mut self) -> u64

Generates a 64-bit unsigned integer by clocking the LFSR in reverse (left shift).

Note, that this will not just return the numbers generated with get_64bits() in reverse order.

Trait Implementations

impl RngCore for Linear16

fn next_u32(&mut self) -> u32

Return the next random u32.

fn next_u64(&mut self) -> u64

Return the next random u64.

fn fill_bytes(&mut self, dest: &mut [u8])

Fill dest with random data.

fn try_fill_bytes(&mut self, dest: &mut [u8]) -> Result<(), Error>

Fill dest entirely with random data.

impl SeedableRng for Linear16

type Seed = [u8; 2]

Seed type, which is restricted to types mutably-dereferenceable as u8 arrays (we recommend [u8; N] for some N).

fn from_seed(seed: [u8; 2]) -> Self

Create a new PRNG using the given seed.

fn seed_from_u64(seed: u64) -> Self

Create a new PRNG using a u64 seed.

fn from_rng<R>(rng: R) -> Result<Self, Error>

where R: RngCore,

Create a new PRNG seeded from another Rng.

fn from_entropy() -> Self

Creates a new instance of the RNG seeded via getrandom.