Struct demes::Deme

pub struct Deme { /* private fields */ }

A resolved deme.

Implementations

impl Deme

pub fn start_times(&self) -> impl Iterator<Item = Time> + '_

Iterator over resolved epoch start times

pub fn start_time(&self) -> Time

The resolved start time

pub fn name(&self) -> &str

Deme name

pub fn time_interval(&self) -> TimeInterval

The resolved time interval

pub fn num_ancestors(&self) -> usize

Number of ancestors

pub fn start_sizes(&self) -> impl Iterator<Item = DemeSize> + '_

Iterator over resolved epoch start sizes.

pub fn end_sizes(&self) -> impl Iterator<Item = DemeSize> + '_

Iterator over resolved epoch end sizes

pub fn end_times(&self) -> impl Iterator<Item = Time> + '_

Itertor over resolved epoch end times

pub fn end_time(&self) -> Time

End time of the deme.

Obtained from the value stored in the most recent epoch.

pub fn ancestors(&self) -> &HashMap<String, usize>

Hash map of ancestor name to ancestor deme

pub fn start_size(&self) -> DemeSize

Resolved start size

pub fn end_size(&self) -> DemeSize

Resolved end size

pub fn ancestor_names(&self) -> &[String]

Names of ancestor demes.

Empty if no ancestors.

pub fn description(&self) -> &str

Description string

pub fn num_epochs(&self) -> usize

Obtain the number of Epoch instances.

Examples

See here.

pub fn epochs(&self) -> &[Epoch]

Resolved epochs

pub fn get_epoch(&self, epoch: usize) -> Option<Epoch>

Returns a copy of the Epoch at index epoch.

Examples

See here for examples.

pub fn proportions(&self) -> &[Proportion]

Resolved proportions

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

Size of Deme at a given time

Trait Implementations

impl Clone for Deme

fn clone(&self) -> Deme

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Deme

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

Formats the value using the given formatter.

impl PartialEq<Deme> for Deme

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 Serialize for Deme

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

Serialize this value into the given Serde serializer.