Enum demes::SizeFunction

#[non_exhaustive]
pub enum SizeFunction {
    Constant,
    Exponential,
    Linear,
}

Specify how deme sizes change during an Epoch.

Examples

let yaml = "
time_units: years
generation_time: 25
description:
  A deme of 50 individuals that grew to 100 individuals
  in the last 100 years.
  Default behavior is that size changes are exponential.
demes:
 - name: deme
   epochs:
    - start_size: 50
      end_time: 100
    - start_size: 50
      end_size: 100
";
let graph = demes::loads(yaml).unwrap();
let deme = graph.get_deme_from_name("deme").unwrap();
assert_eq!(deme.num_epochs(), 2);
let last_epoch = deme.get_epoch(1).unwrap();
assert!(matches!(last_epoch.size_function(),
                 demes::SizeFunction::Exponential));
let first_epoch = deme.get_epoch(0).unwrap();
assert!(matches!(first_epoch.size_function(),
                 demes::SizeFunction::Constant));

Let’s change the function to linear for the second epoch:

let yaml = "
time_units: years
generation_time: 25
description:
  A deme of 50 individuals that grew to 100 individuals
  in the last 100 years.
demes:
 - name: deme
   epochs:
    - start_size: 50
      end_time: 100
    - start_size: 50
      end_size: 100
      size_function: linear
";
let graph = demes::loads(yaml).unwrap();
let deme = graph.get_deme_from_name("deme").unwrap();
let last_epoch = deme.get_epoch(1).unwrap();
assert!(matches!(last_epoch.size_function(),
                 demes::SizeFunction::Linear));

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Constant

Exponential

Linear

Trait Implementations

impl Clone for SizeFunction

fn clone(&self) -> SizeFunction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SizeFunction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SizeFunction

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SizeFunction

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

Formats the value using the given formatter.

impl PartialEq for SizeFunction

fn eq(&self, other: &SizeFunction) -> 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 Serialize for SizeFunction

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for SizeFunction

impl Eq for SizeFunction

impl StructuralPartialEq for SizeFunction