Struct tskit::MigrationTable [−][src]
pub struct MigrationTable<'a> { /* fields omitted */ }Expand description
An immutable view of a migration table.
These are not created directly.
Instead, use TableCollection::migrations
to get a reference to an existing node table;
Implementations
impl<'a> MigrationTable<'a>[src]
impl<'a> MigrationTable<'a>[src]pub fn num_rows(&'a self) -> tsk_size_t[src]
pub fn num_rows(&'a self) -> tsk_size_t[src]Return the number of rows
pub fn dest(&'a self, row: tsk_id_t) -> Result<tsk_id_t, TskitError>[src]
pub fn dest(&'a self, row: tsk_id_t) -> Result<tsk_id_t, TskitError>[src]Return the destination population for a given row.
Errors
TskitError::IndexErrorifrowis out of range.
pub fn time(&'a self, row: tsk_id_t) -> Result<f64, TskitError>[src]
pub fn time(&'a self, row: tsk_id_t) -> Result<f64, TskitError>[src]Return the time of the migration event for a given row.
Errors
TskitError::IndexErrorifrowis out of range.
pub fn metadata<T: MetadataRoundtrip>(
&'a self,
row: tsk_id_t
) -> Result<Option<T>, TskitError>[src]
pub fn metadata<T: MetadataRoundtrip>(
&'a self,
row: tsk_id_t
) -> Result<Option<T>, TskitError>[src]pub fn iter(&self) -> TableIterator<&'_ MigrationTable<'_>>[src]
pub fn iter(&self) -> TableIterator<&'_ MigrationTable<'_>>[src]Return an iterator over rows of the table.
The value of the iterator is MigrationTableRow.
pub fn row(&self, r: tsk_id_t) -> Result<MigrationTableRow, TskitError>[src]
pub fn row(&self, r: tsk_id_t) -> Result<MigrationTableRow, TskitError>[src]Return row r of the table.
Parameters
r: the row id.
Errors
TskitError::IndexError if r is out of range.