Struct demes::Proportion

#[repr(transparent)]
pub struct Proportion(_);

An ancestry proportion.

This is a newtype wrapper for f64.

Interpretation

With respect to a deme in an offspring time step, a proportion is the fraction of ancsestry from a given parental deme.

Examples

In YAML input

Ancestral proportions of demes

let yaml = "
time_units: generations
description:
  An admixed deme appears 100 generations ago.
  Its initial ancestry is 90% from ancestor1
  and 10% from ancestor2.
demes:
 - name: ancestor1
   epochs:
    - start_size: 50
      end_time: 100
 - name: ancestor2
   epochs:
    - start_size: 50
      end_time: 100
 - name: admixed
   ancestors: [ancestor1, ancestor2]
   proportions: [0.9, 0.1]
   start_time: 100
   epochs:
    - start_size: 200
";
demes::loads(yaml).unwrap();

Pulse proportions

let yaml = "
time_units: generations
description:
   Two demes coexist without migration.
   Sixty three (63) generations ago,
   deme1 contributes 50% of ancestry
   to all individuals born in deme2.
demes:
 - name: deme1
   epochs:
    - start_size: 50
 - name: deme2
   epochs:
    - start_size: 50
pulses:
 - sources: [deme1]
   dest: deme2
   proportions: [0.5]
   time: 63
";
demes::loads(yaml).unwrap();

Using rust code

Normally, one only needs to create a Proportion when working with GraphBuilder.

let t = demes::Proportion::from(0.5);
assert_eq!(t, 0.5);

Trait Implementations

impl Clone for Proportion

fn clone(&self) -> Proportion

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Proportion

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Proportion

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Proportion

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

Formats the value using the given formatter.

impl From<Proportion> for f64

fn from(value: Proportion) -> f64

Converts to this type from the input type.

impl From<f64> for Proportion

fn from(value: f64) -> Self

Converts to this type from the input type.

impl Ord for Proportion

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Proportion> for Proportion

fn eq(&self, other: &Self) -> 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 PartialEq<Proportion> for f64

fn eq(&self, other: &Proportion) -> 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 PartialEq<f64> for Proportion

fn eq(&self, other: &f64) -> 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 PartialOrd<Proportion> for Proportion

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<Proportion> for f64

fn partial_cmp(&self, other: &Proportion) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<f64> for Proportion

fn partial_cmp(&self, other: &f64) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Proportion

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 Proportion

impl Eq for Proportion