Struct pcg_rand::PcgEngine

pub struct PcgEngine<Itype, Xtype, StreamMix: Stream<Itype>, MulMix: Multiplier<Itype>, OutMix: OutputMixin<Itype, Xtype>> {
    // some fields omitted
}

A generic PCG structure.

This structure allows the building of many types of PCG generators by using various Mixins for both the stream, multiplier, and permutation function.

Methods

impl<Itype, Xtype, StreamMix, MulMix, OutMix> PcgEngine<Itype, Xtype, StreamMix, MulMix, OutMix> where Itype: PcgOps + BitSize + AsSmaller<Xtype> + Clone, Xtype: PcgOps + BitSize, StreamMix: Stream<Itype>, MulMix: Multiplier<Itype>, OutMix: OutputMixin<Itype, Xtype>

fn new_unseeded() -> Self

Trait Implementations

impl<Itype, StreamMix, MulMix, OutMix> Rng for PcgEngine<Itype, u32, StreamMix, MulMix, OutMix> where Itype: PcgOps + BitSize + AsSmaller<u32> + Clone, StreamMix: Stream<Itype>, MulMix: Multiplier<Itype>, OutMix: OutputMixin<Itype, u32>

fn next_u32(&mut self) -> u32

Return the next random u32.

fn next_u64(&mut self) -> u64

Return the next random u64.

fn next_f32(&mut self) -> f32

Return the next random f32 selected from the half-open interval [0, 1).

fn next_f64(&mut self) -> f64

Return the next random f64 selected from the half-open interval [0, 1).

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

Fill dest with random data.

fn gen<T>(&mut self) -> T where T: Rand

Return a random value of a Rand type.

fn gen_iter<T>(&'a mut self) -> Generator<'a, T, Self> where T: Rand

Return an iterator that will yield an infinite number of randomly generated items.

fn gen_range<T>(&mut self, low: T, high: T) -> T where T: SampleRange + PartialOrd<T>

Generate a random value in the range [low, high).

fn gen_weighted_bool(&mut self, n: u32) -> bool

Return a bool with a 1 in n chance of true

fn gen_ascii_chars(&'a mut self) -> AsciiGenerator<'a, Self>

Return an iterator of random characters from the set A-Z,a-z,0-9.

fn choose<T>(&mut self, values: &'a [T]) -> Option<&'a T>

Return a random element from values.

fn shuffle<T>(&mut self, values: &mut [T])

Shuffle a mutable slice in place.

impl<Itype, StreamMix, MulMix, OutMix> Rng for PcgEngine<Itype, u64, StreamMix, MulMix, OutMix> where Itype: PcgOps + BitSize + AsSmaller<u64> + Clone, StreamMix: Stream<Itype>, MulMix: Multiplier<Itype>, OutMix: OutputMixin<Itype, u64>

fn next_u32(&mut self) -> u32

Return the next random u32.

fn next_u64(&mut self) -> u64

Return the next random u64.

fn next_f32(&mut self) -> f32

Return the next random f32 selected from the half-open interval [0, 1).

fn next_f64(&mut self) -> f64

Return the next random f64 selected from the half-open interval [0, 1).

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

Fill dest with random data.

fn gen<T>(&mut self) -> T where T: Rand

Return a random value of a Rand type.

fn gen_iter<T>(&'a mut self) -> Generator<'a, T, Self> where T: Rand

Return an iterator that will yield an infinite number of randomly generated items.

fn gen_range<T>(&mut self, low: T, high: T) -> T where T: SampleRange + PartialOrd<T>

Generate a random value in the range [low, high).

fn gen_weighted_bool(&mut self, n: u32) -> bool

Return a bool with a 1 in n chance of true

fn gen_ascii_chars(&'a mut self) -> AsciiGenerator<'a, Self>

Return an iterator of random characters from the set A-Z,a-z,0-9.

fn choose<T>(&mut self, values: &'a [T]) -> Option<&'a T>

Return a random element from values.

fn shuffle<T>(&mut self, values: &mut [T])

Shuffle a mutable slice in place.

impl<Itype, Xtype, StreamMix, MulMix, OutMix> Rand for PcgEngine<Itype, Xtype, StreamMix, MulMix, OutMix> where Itype: PcgOps + BitSize + AsSmaller<Xtype> + Clone + Rand, Xtype: PcgOps + BitSize, StreamMix: Stream<Itype> + Rand, MulMix: Multiplier<Itype>, OutMix: OutputMixin<Itype, Xtype>

fn rand<R: Rng>(rng: &mut R) -> Self

Generates a random instance of this type using the specified source of randomness.

impl<Xtype, StreamMix, MulMix, OutMix> SeedableRng<u64> for PcgEngine<u64, Xtype, StreamMix, MulMix, OutMix> where Xtype: PcgOps + BitSize, StreamMix: Stream<u64>, MulMix: Multiplier<u64>, OutMix: OutputMixin<u64, Xtype>, PcgEngine<u64, Xtype, StreamMix, MulMix, OutMix>: Rng

fn reseed(&mut self, seed: u64)

Reseed an RNG with the given seed.

fn from_seed(seed: u64) -> Self

Create a new RNG with the given seed.

impl<Xtype, StreamMix, MulMix, OutMix> SeedableRng<[u64; 2]> for PcgEngine<u128, Xtype, StreamMix, MulMix, OutMix> where Xtype: PcgOps + BitSize, StreamMix: Stream<u128>, MulMix: Multiplier<u128>, OutMix: OutputMixin<u128, Xtype>, PcgEngine<u128, Xtype, StreamMix, MulMix, OutMix>: Rng

fn reseed(&mut self, seed: [u64; 2])

Reseed an RNG with the given seed.

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

Create a new RNG with the given seed.

impl<Xtype, StreamMix, MulMix, OutMix> SeedableRng<u128> for PcgEngine<u128, Xtype, StreamMix, MulMix, OutMix> where Xtype: PcgOps + BitSize, StreamMix: Stream<u128>, MulMix: Multiplier<u128>, OutMix: OutputMixin<u128, Xtype>, PcgEngine<u128, Xtype, StreamMix, MulMix, OutMix>: Rng

fn reseed(&mut self, seed: u128)

Reseed an RNG with the given seed.

fn from_seed(seed: u128) -> Self

Create a new RNG with the given seed.

impl<Xtype, MulMix, OutMix> SeedableRng<[u64; 2]> for PcgEngine<u64, Xtype, SpecificSeqStream<u64>, MulMix, OutMix> where Xtype: PcgOps + BitSize, MulMix: Multiplier<u64>, OutMix: OutputMixin<u64, Xtype>, PcgEngine<u64, Xtype, SpecificSeqStream<u64>, MulMix, OutMix>: Rng

fn reseed(&mut self, seed: [u64; 2])

Reseed an RNG with the given seed.

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

Create a new RNG with the given seed.

impl<Xtype, MulMix, OutMix> SeedableRng<[u64; 4]> for PcgEngine<u128, Xtype, SpecificSeqStream<u128>, MulMix, OutMix> where Xtype: PcgOps + BitSize, MulMix: Multiplier<u128>, OutMix: OutputMixin<u128, Xtype>, PcgEngine<u128, Xtype, SpecificSeqStream<u128>, MulMix, OutMix>: Rng

fn reseed(&mut self, seed: [u64; 4])

Reseed an RNG with the given seed.

fn from_seed(seed: [u64; 4]) -> Self

Create a new RNG with the given seed.

impl<Xtype, MulMix, OutMix> SeedableRng<[u128; 2]> for PcgEngine<u128, Xtype, SpecificSeqStream<u128>, MulMix, OutMix> where Xtype: PcgOps + BitSize, MulMix: Multiplier<u128>, OutMix: OutputMixin<u128, Xtype>, PcgEngine<u128, Xtype, SpecificSeqStream<u128>, MulMix, OutMix>: Rng

fn reseed(&mut self, seed: [u128; 2])

Reseed an RNG with the given seed.

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

Create a new RNG with the given seed.