Struct ExperimentMetadata 

pub struct ExperimentMetadata {
    pub generations: usize,
    pub rng_seed: Option<u64>,
    pub rng_description: String,
}

Metadata describing an executed experiment.

Examples

use jeans::ExperimentMetadata;
let metadata = ExperimentMetadata::new(10, Some(7), "StdRng");
assert_eq!(metadata.generations, 10);

Fields

generations: usize

Number of generations executed by the experiment.

rng_seed: Option<u64>

Optional RNG seed recorded by the caller.

rng_description: String

Human readable description of the RNG used for the run.

Implementations

impl ExperimentMetadata

pub fn new( generations: usize, rng_seed: Option<u64>, rng_description: impl Into<String>, ) -> Self

Creates a new metadata record.

Trait Implementations

impl Clone for ExperimentMetadata

fn clone(&self) -> ExperimentMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExperimentMetadata

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

Formats the value using the given formatter.