Struct demes::UnresolvedMigration

pub struct UnresolvedMigration {
    pub demes: Option<Vec<String>>,
    pub source: Option<String>,
    pub dest: Option<String>,
    pub start_time: Option<InputTime>,
    pub end_time: Option<InputTime>,
    pub rate: Option<InputMigrationRate>,
}

An unresolved migration epoch.

All input migrations are resolved to AsymmetricMigration instances.

Examples

GraphBuilder

This type supports member field initialization using defaults. This form of initalization is used in:

• GraphDefaults

let _ = demes::UnresolvedMigration{source: Some("A".to_string()),
                                   dest: Some("B".to_string()),
                                   rate: Some(0.2.into()),
                                   ..Default::default()
                                   };

Fields

demes: Option<Vec<String>>

The demes involved in symmetric migration epochs

source: Option<String>

The source deme of an asymmetric migration epoch

dest: Option<String>

The destination deme of an asymmetric migration epoch

start_time: Option<InputTime>

The start time of a migration epoch

end_time: Option<InputTime>

The end time of a migration epoch

rate: Option<InputMigrationRate>

The rate during a migration epoch

Implementations

impl UnresolvedMigration

pub fn set_source<A>(self, source: A) -> Self

where A: AsRef<str>,

Set the source deme

See [‘GraphBuilder’].

Examples

let _ = demes::UnresolvedMigration::default().set_source("A");

pub fn set_dest<A>(self, dest: A) -> Self

where A: AsRef<str>,

Set the destination deme

See [‘GraphBuilder’].

Examples

let _ = demes::UnresolvedMigration::default().set_dest("A");

pub fn set_demes<I, A>(self, d: I) -> Self

where I: IntoIterator<Item = A>, A: AsRef<str>,

Set the demes

See [‘GraphBuilder’].

Examples

let _ = demes::UnresolvedMigration::default().set_demes(["A", "B"].as_slice());

pub fn set_start_time<T>(self, time: T) -> Self

where T: Into<InputTime>,

Set the start time

See [‘GraphBuilder’].

Examples

let _ = demes::UnresolvedMigration::default().set_start_time(1.0);

pub fn set_end_time<T>(self, time: T) -> Self

where T: Into<InputTime>,

Set the end time

See [‘GraphBuilder’].

Examples

let _ = demes::UnresolvedMigration::default().set_end_time(10.);

pub fn set_rate<R>(self, rate: R) -> Self

where R: Into<InputMigrationRate>,

Set the symmetric migration rate among all demes.

See [‘GraphBuilder’].

Examples

let _ = demes::UnresolvedMigration::default().set_rate(0.3333);

Trait Implementations

impl Clone for UnresolvedMigration

fn clone(&self) -> UnresolvedMigration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UnresolvedMigration

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

Formats the value using the given formatter.

impl Default for UnresolvedMigration

fn default() -> UnresolvedMigration

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UnresolvedMigration

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for UnresolvedMigration

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for UnresolvedMigration