Enum RngSource

pub enum RngSource {
    Default,
    Seed(u64),
    Rng(StdRng),
}

Defines a source for a StdRng.

Examples

use rand::rngs::StdRng;
use rand::SeedableRng;
use burn_dataset::transform::RngSource;

// Default via `StdRng::from_os_rng()` (`RngSource::Default`)
let system: RngSource = RngSource::default();

// From a fixed seed (`RngSource::Seed`)
let seeded: RngSource = 42.into();

// From an existing rng (`RngSource::Rng`)
let rng = StdRng::seed_from_u64(123);
let with_rng: RngSource = rng.into();

// From a snapshot of the current state (`RngSource::Rng`)
let rng = StdRng::seed_from_u64(123);
let snapshot: RngSource = (&rng).into();

// Advances the original RNG and then clones its new state
let mut rng = StdRng::seed_from_u64(123);
let stateful: RngSource = (&mut rng).into();

Variants

Default

Build a new rng from the system.

Seed(u64)

The rng is passed as a seed.

Rng(StdRng)

The rng is passed as an option.

Trait Implementations

impl Clone for RngSource

fn clone(&self) -> RngSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RngSource

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

Formats the value using the given formatter.

impl Default for RngSource

fn default() -> RngSource

Returns the “default value” for a type.

impl From<&StdRng> for RngSource

fn from(rng: &StdRng) -> RngSource

Converts to this type from the input type.

impl From<&mut StdRng> for RngSource

Users calling with a mutable rng expect state advancement, So conversion from &mut StdRng advances the rng before cloning.

fn from(rng: &mut StdRng) -> RngSource

Converts to this type from the input type.

impl From<RngSource> for StdRng

fn from(source: RngSource) -> StdRng

Converts to this type from the input type.

impl From<StdRng> for RngSource

fn from(rng: StdRng) -> RngSource

Converts to this type from the input type.

impl From<u64> for RngSource

fn from(seed: u64) -> RngSource

Converts to this type from the input type.

impl PartialEq for RngSource

fn eq(&self, other: &RngSource) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for RngSource

impl StructuralPartialEq for RngSource