demes-forward 0.6.0

rust API for iterating demes models forwards in time
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

//! # Forward-time traversal of demes models.
//!
//! ## Re-exports
//!
//! This crate re-exports `demes`.
//! Client code does not have to list `demes`
//! as a cargo dependency, guaranteeing that
//! a compatible version is available.
//!
//! ```rust
//! use demes_forward::demes;
//!
//! let yaml = "
//! time_units: generations
//! demes:
//!  - name: a_deme
//!    epochs:
//!     - start_size: 100
//! ";
//! assert!(demes::loads(yaml).is_ok());
//! ```

#![warn(missing_docs)]
#![deny(rustdoc::broken_intra_doc_links)]

mod current_size;
mod error;
mod graph;
mod iterators;
mod square_matrix;
mod time;

#[cfg(test)]
mod test_functions;

pub use current_size::CurrentSize;
pub use demes;
pub use error::DemesForwardError;
pub use graph::ForwardGraph;
pub use time::ForwardTime;

/// The size of a deme at a given time.
#[derive(Copy, Clone, Debug, PartialEq, PartialOrd)]
pub struct DemeSizeAt {
    time: demes::Time,
    forward_time: ForwardTime,
    size: CurrentSize,
}

impl DemeSizeAt {
    /// The current time (in the past)
    pub fn time(&self) -> demes::Time {
        self.time
    }
    /// The current time measured since the
    /// start of the model, forwards in time
    pub fn forward_time(&self) -> ForwardTime {
        self.forward_time
    }
    /// The current size
    pub fn size(&self) -> CurrentSize {
        self.size
    }
}