Enum InitialStateRecipe 

pub enum InitialStateRecipe {
    Random {
        distribution: DistributionSource,
        rng: RngConfig,
    },
    CenteredSeed {
        distribution: DistributionSource,
        seed_taxon: usize,
        seed_radius: usize,
        rng: RngConfig,
    },
    CenteredDominantSeed {
        distribution: DistributionSource,
        seed_radius: usize,
        rng: RngConfig,
    },
}

Reproducible scientific instructions for one categorical state.

Variants

Random

Fields

distribution: DistributionSource

rng: RngConfig

CenteredSeed

Fields

distribution: DistributionSource

seed_taxon: usize

seed_radius: usize

rng: RngConfig

CenteredDominantSeed

Fields

distribution: DistributionSource

seed_radius: usize

rng: RngConfig

Implementations

impl InitialStateRecipe

pub const fn method(&self) -> InitializationMethod

pub fn distribution_path(&self) -> Option<&Path>

pub fn validate( &self, lattice: &SquareLatticeConfig, num_taxa: usize, ) -> Result<(), InitialStateError>

pub fn create( self, lattice: SquareLatticeConfig, num_taxa: usize, ) -> Result<InitialState, InitialStateError>

Trait Implementations

impl Clone for InitialStateRecipe

fn clone(&self) -> InitialStateRecipe

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InitialStateRecipe

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InitialStateRecipe

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for InitialStateRecipe

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for InitialStateRecipe

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for InitialStateRecipe