Trait Distrib 

pub trait Distrib: Clone {
    type Sample;

    // Required method
    fn sample(&self, rng: &mut DefaultRng) -> Self::Sample;

    // Provided method
    fn samples(
        &self,
        rng: &mut DefaultRng,
    ) -> impl Iterator<Item = Self::Sample> { ... }
}

Trait for generating values sampled from a probability distribution.

Required Associated Types

type Sample

The type of the elements of the sample space of Self, also called “outcomes”.

Required Methods

fn sample(&self, rng: &mut DefaultRng) -> Self::Sample

Returns a pseudo-random value sampled from self.

Examples

use retrofire_core::math::rand::*;

// Simulate rolling a six-sided die
let rng = &mut DefaultRng::default();
let d6 = Uniform(1..7).sample(rng);
assert_eq!(d6, 3);

Provided Methods

fn samples(&self, rng: &mut DefaultRng) -> impl Iterator<Item = Self::Sample>

Returns an iterator that yields samples from self indefinitely.

Examples

use retrofire_core::math::rand::*;

// Simulate rolling a six-sided die three times
let rng = &mut DefaultRng::default();
let mut iter = Uniform(1u32..7).samples(rng);

assert_eq!(iter.next(), Some(1));
assert_eq!(iter.next(), Some(2));
assert_eq!(iter.next(), Some(4));

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<D: Distrib, E: Distrib> Distrib for (D, E)

fn sample(&self, rng: &mut DefaultRng) -> Self::Sample

Returns a pair of samples, sampled from two separate distributions.

type Sample = (<D as Distrib>::Sample, <E as Distrib>::Sample)

Implementors

impl Distrib for Bernoulli

type Sample = bool

impl Distrib for PointsInUnitBall

type Sample = Point<[f32; 3], Real<3>>

impl Distrib for PointsOnUnitDisk

type Sample = Point<[f32; 2], Real<2>>

impl Distrib for Uniform<f32>

Uniformly distributed floats.

type Sample = f32

impl Distrib for Uniform<i32>

Uniformly distributed signed integers.

type Sample = i32

impl Distrib for Uniform<u32>

Uniformly distributed unsigned integers.

type Sample = u32

impl Distrib for Uniform<usize>

Uniformly distributed indices.

type Sample = usize

impl Distrib for UnitCircle

Available on crate feature fp only.

type Sample = Vector<[f32; 2], Real<2>>

impl Distrib for UnitSphere

Available on crate feature fp only.

type Sample = Vector<[f32; 3], Real<3>>

impl Distrib for VectorsInUnitBall

type Sample = Vector<[f32; 3], Real<3>>

impl Distrib for VectorsOnUnitDisk

type Sample = Vector<[f32; 2], Real<2>>

impl<Sc, Sp, const DIM: usize> Distrib for Uniform<Color<[Sc; DIM], Sp>>

where Sc: Copy, Sp: Clone, Uniform<[Sc; DIM]>: Distrib<Sample = [Sc; DIM]>,

type Sample = Point<[Sc; DIM], Sp>

impl<Sc, Sp, const DIM: usize> Distrib for Uniform<Point<[Sc; DIM], Sp>>

where Sc: Copy, Uniform<[Sc; DIM]>: Distrib<Sample = [Sc; DIM]>,

Uniformly distributed points within a rectangular volume.

type Sample = Point<[Sc; DIM], Sp>

impl<Sc, Sp, const DIM: usize> Distrib for Uniform<Vector<[Sc; DIM], Sp>>

where Sc: Copy, Uniform<[Sc; DIM]>: Distrib<Sample = [Sc; DIM]>,

Uniformly distributed vectors within a rectangular volume.

type Sample = Vector<[Sc; DIM], Sp>

impl<T, const N: usize> Distrib for Uniform<[T; N]>

where T: Copy, Uniform<T>: Distrib<Sample = T>,

type Sample = [T; N]