Struct rand::distributions::Slice

source ·
pub struct Slice<'a, T> { /* private fields */ }
Expand description

A distribution to sample items uniformly from a slice.

Slice::new constructs a distribution referencing a slice and uniformly samples references from the items in the slice. It may do extra work up front to make sampling of multiple values faster; if only one sample from the slice is required, SliceRandom::choose can be more efficient.

Steps are taken to avoid bias which might be present in naive implementations; for example slice[rng.gen() % slice.len()] samples from the slice, but may be more likely to select numbers in the low range than other values.

This distribution samples with replacement; each sample is independent. Sampling without replacement requires state to be retained, and therefore cannot be handled by a distribution; you should instead consider methods on SliceRandom, such as SliceRandom::choose_multiple.

Example

use rand::Rng;
use rand::distributions::Slice;

let vowels = ['a', 'e', 'i', 'o', 'u'];
let vowels_dist = Slice::new(&vowels).unwrap();
let rng = rand::thread_rng();

// build a string of 10 vowels
let vowel_string: String = rng
    .sample_iter(&vowels_dist)
    .take(10)
    .collect();

println!("{}", vowel_string);
assert_eq!(vowel_string.len(), 10);
assert!(vowel_string.chars().all(|c| vowels.contains(&c)));

For a single sample, SliceRandom::choose may be preferred:

use rand::seq::SliceRandom;

let vowels = ['a', 'e', 'i', 'o', 'u'];
let mut rng = rand::thread_rng();

println!("{}", vowels.choose(&mut rng).unwrap())

Implementations§

source§

impl<'a, T> Slice<'a, T>

source

pub fn new(slice: &'a [T]) -> Result<Self, EmptySlice>

Create a new Slice instance which samples uniformly from the slice. Returns Err if the slice is empty.

Trait Implementations§

source§

impl<'a, T: Clone> Clone for Slice<'a, T>

source§

fn clone(&self) -> Slice<'a, T>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<'a, T: Debug> Debug for Slice<'a, T>

source§

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

Formats the value using the given formatter. Read more
source§

impl<'a, T> Distribution<&'a T> for Slice<'a, T>

source§

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> &'a T

Generate a random value of T, using rng as the source of randomness.
source§

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>
where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness. Read more
source§

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>
where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F Read more
source§

impl<'a, T: Copy> Copy for Slice<'a, T>

Auto Trait Implementations§

§

impl<'a, T> RefUnwindSafe for Slice<'a, T>
where T: RefUnwindSafe,

§

impl<'a, T> Send for Slice<'a, T>
where T: Sync,

§

impl<'a, T> Sync for Slice<'a, T>
where T: Sync,

§

impl<'a, T> Unpin for Slice<'a, T>

§

impl<'a, T> UnwindSafe for Slice<'a, T>
where T: RefUnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V