Struct demes::Epoch

pub struct Epoch { /* private fields */ }

A resolved epoch

Implementations

impl Epoch

pub fn size_function(&self) -> SizeFunction

The resolved size function

pub fn selfing_rate(&self) -> SelfingRate

The resolved selfing rate

pub fn cloning_rate(&self) -> CloningRate

The resolved cloning rate

pub fn start_time(&self) -> Time

The resolved start time

pub fn end_time(&self) -> Time

The resolved end time

pub fn start_size(&self) -> DemeSize

The resolved start size

pub fn end_size(&self) -> DemeSize

The resolved end size

pub fn time_interval(&self) -> TimeInterval

The resolved time interval

pub fn size_at<F: Into<f64>>( &self, time: F ) -> Result<Option<DemeSize>, DemesError>

Size of Epoch at a given time

Returns

• Some(size) if time falls within the epoch’s time interval.
• None if time is a valid time but outside of the epochs’ time interval.

Errors

• If time fails to convert into Time.
• If conversion from f64 to DemeSize fails during calculation of size change function.

Trait Implementations

impl Clone for Epoch

fn clone(&self) -> Epoch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Epoch

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

Formats the value using the given formatter.

impl PartialEq for Epoch

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

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 Epoch

impl Eq for Epoch

impl StructuralPartialEq for Epoch