Struct demes::Graph

pub struct Graph { /* private fields */ }

A resolved demes Graph.

Instances of this type will be fully-resolved according to the machine data model described here.

A graph cannot be directly initialized. See:

• load
• loads
• GraphBuilder

Implementations

impl Graph

pub fn num_demes(&self) -> usize

The number of Deme instances in the graph.

pub fn get_deme_from_name<'name>( &'name self, name: &'name str ) -> Option<&'name Deme>

Obtain a reference to a Deme by its name.

Returns

Some(&Deme) if name exists, None otherwise.

Examples

See here.

pub fn deme(&self, at: usize) -> &Deme

Get the Deme at index at.

pub fn get_deme(&self, at: usize) -> Option<&Deme>

Get the Deme at index at.

Details

Returns None if at is out of range.

pub fn demes(&self) -> &[Deme]

Get the Deme instances via a slice.

pub fn generation_time(&self) -> GenerationTime

Get the GenerationTime for the graph.

pub fn time_units(&self) -> TimeUnits

Get the TimeUnits for the graph.

pub fn migrations(&self) -> &[AsymmetricMigration]

Get the migration events for the graph.

pub fn pulses(&self) -> &[Pulse]

Get the pulse events for the graph.

pub fn metadata(&self) -> Option<Metadata>

Get a copy of the top-level Metadata.

pub fn into_generations(self) -> Result<Self, DemesError>

Convert the time units to generations.

Errors

If the time unit of an event differs sufficiently in magnitude from the generation_time, it is possible that conversion results in epochs (or migration durations) of length zero, which will return an error.

If any field is unresolved, an error will be returned.

pub fn into_integer_generations(self) -> Result<Graph, DemesError>

Convert the time units to generations, rounding the output to an integer value.

pub fn into_generations_with( self, with: fn(_: Time, _: GenerationTime) -> Time ) -> Result<Graph, DemesError>

Convert the time units to generations with a callback to specify the conversion policy

pub fn as_string(&self) -> Result<String, DemesError>

Return a representation of the graph as a string.

The format is in YAML and corresponds to the MDM representation of the data.

Error

Will return an error if serde_yaml::to_string returns an error.

pub fn as_json_string(&self) -> Result<String, DemesError>

Available on crate feature json only.

Return a representation of the graph as a string.

The format is in JSON and corresponds to the MDM representation of the data.

Error

Will return an error if serde_json::to_string returns an error.

pub fn most_recent_deme_end_time(&self) -> Time

Return the most recent end time of any deme in the Graph.

This function is useful to check if the most recent end time is greater than zero, meaning that the model ends at a time point ancestral to “now”.

pub fn description(&self) -> Option<&str>

Return the description field.

pub fn doi(&self) -> impl Iterator<Item = &str>

Return an iterator over DOI information.

pub fn has_non_integer_sizes(&self) -> Option<(&str, usize)>

Check if any epochs have non-integer start_size or end_size.

Returns

• The deme name and epoch index where the first non-integer value is encountered
• None if non non-integer values are encountered

pub fn into_integer_start_end_sizes(self) -> Result<Self, DemesError>

Round all epoch start/end sizes to nearest integer value.

Returns

A modified graph with rounded sizes.

Error

• EpochError if rounding leads to a value of 0.

Note

Rounding uses f64::round

Trait Implementations

impl Debug for Graph

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

Formats the value using the given formatter.

impl Display for Graph

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

Formats the value using the given formatter.

impl PartialEq<Graph> for Graph

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 Graph

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

Serialize this value into the given Serde serializer.

impl Eq for Graph