Struct Uniform 

pub struct Uniform<T>(pub Range<T>);

A uniform distribution of values in a range.

Tuple Fields

0: Range<T>

Trait Implementations

impl<T: Clone> Clone for Uniform<T>

fn clone(&self) -> Uniform<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for Uniform<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

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

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

fn sample(&self, rng: &mut DefaultRng) -> [T; N]

Returns the coordinates of a point sampled from a uniform distribution within the N-dimensional rectangular volume bounded by self.0.

Examples

use retrofire_core::math::rand::*;
let rng = &mut DefaultRng::default();

// Pairs of integers [X, Y] such that 0 <= X < 4 and -2 <= Y <= 3
let mut int_pairs = Uniform([0, -2]..[4, 3]).samples(rng);

assert_eq!(int_pairs.next(), Some([0, -1]));
assert_eq!(int_pairs.next(), Some([1, 0]));
assert_eq!(int_pairs.next(), Some([3, 1]));

type Sample = [T; N]

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

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

Returns an iterator that yields samples from self indefinitely.

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]>,

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

Returns a point uniformly sampled from the rectangular volume bounded by self.0.

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

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

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

Returns an iterator that yields samples from self indefinitely.

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.

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

Returns a point uniformly sampled from the rectangular volume bounded by self.0.

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

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

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

Returns an iterator that yields samples from self indefinitely.

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.

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

Returns a vector uniformly sampled from the rectangular volume bounded by self.0.

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

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

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

Returns an iterator that yields samples from self indefinitely.

impl Distrib for Uniform<f32>

Uniformly distributed floats.

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

Returns a uniformly distributed f32 in the range.

Examples

use retrofire_core::math::rand::*;
let rng = &mut DefaultRng::default();

// Floats in the interval [-1, 1)
let mut iter = Uniform(-1.0..1.0).samples(rng);
assert_eq!(iter.next(), Some(0.19692874));
assert_eq!(iter.next(), Some(-0.7686298));
assert_eq!(iter.next(), Some(0.91969657));

type Sample = f32

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

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

Returns an iterator that yields samples from self indefinitely.

impl Distrib for Uniform<i32>

Uniformly distributed signed integers.

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

Returns a uniformly distributed i32 in the range.

Examples

use retrofire_core::math::rand::*;
let rng = &mut DefaultRng::default();


let mut iter = Uniform(-5i32..6).samples(rng);
assert_eq!(iter.next(), Some(0));
assert_eq!(iter.next(), Some(4));
assert_eq!(iter.next(), Some(5));

type Sample = i32

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

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

Returns an iterator that yields samples from self indefinitely.

impl Distrib for Uniform<u32>

Uniformly distributed unsigned integers.

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

Returns a uniformly distributed u32 in the range.

Examples

use retrofire_core::math::rand::*;
let rng = &mut DefaultRng::from_seed(1234);

// Simulate rolling a six-sided die
let mut rolls: Vec<_>  = Uniform(1u32..7)
    .samples(rng)
    .take(6)
    .collect();
assert_eq!(rolls, [2, 4, 6, 6, 3, 1]);

type Sample = u32

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

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

Returns an iterator that yields samples from self indefinitely.

impl Distrib for Uniform<usize>

Uniformly distributed indices.

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

Returns a uniformly distributed usize in the range.

Examples

use retrofire_core::math::rand::*;
let rng = &mut DefaultRng::default();

// Randomly sample elements from a list (with replacement)
let beverages = ["water", "tea", "coffee", "Coke", "Red Bull"];
let mut x: Vec<_> = Uniform(0..beverages.len())
    .samples(rng)
    .take(3)
    .map(|i| beverages[i])
    .collect();

assert_eq!(x, ["water", "tea", "Red Bull"]);

type Sample = usize

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

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

Returns an iterator that yields samples from self indefinitely.