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 uniformly distributed point within the N-dimensional rectangular volume bounded by the range self.0.

Examples

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

// Pairs of integers [X, Y] such that 0 <= X < 4 and -2 <= Y <= 3
let mut iter = Uniform([0, -2]..[4, 3]).samples(rng);
assert_eq!(iter.next(), Some([0, -1]));
assert_eq!(iter.next(), Some([1, 0]));
assert_eq!(iter.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: R) -> Iter<Self, R>

Returns an iterator that yields samples from self.

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 uniformly distributed vector within the rectangular volume bounded by the range 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: R) -> Iter<Self, R>

Returns an iterator that yields samples from self.

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 = 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: R) -> Iter<Self, R>

Returns an iterator that yields samples from self.

impl Distrib for Uniform<i32>

Uniformly distributed integers.

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

Returns a uniformly distributed i32 in the range.

Examples

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

// Simulate rolling a six-sided die
let mut iter = Uniform(1..7).samples(rng);
assert_eq!(iter.next(), Some(3));
assert_eq!(iter.next(), Some(2));
assert_eq!(iter.next(), Some(4));

type Sample = i32

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

fn samples(&self, rng: R) -> Iter<Self, R>

Returns an iterator that yields samples from self.