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(&self, name: &str) -> Option<&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.

Panics

Will panic if at is out of range.

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

Get the Deme instances via a slice.

pub fn generation_time(&self) -> Option<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 to_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 to_integer_generations(
    self,
    round: RoundTimeToInteger
) -> Result<Graph, DemesError>

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

Trait Implementations

impl Debug for Graph

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Graph

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

Deserialize this value from the given Serde deserializer.

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 !=.

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