Struct tskit::MigrationTable

pub struct MigrationTable { /* private fields */ }

An immutable view of a migration table.

These are not created directly but are accessed by types implementing std::ops::Deref to crate::table_views::TableViews

Implementations

impl MigrationTable

pub fn num_rows(&self) -> SizeType

Return the number of rows

pub fn left<M: Into<MigrationId> + Copy>(&self, row: M) -> Option<Position>

Return the left coordinate for a given row.

Returns

• Some(position) if row is valid.
• None otherwise.

pub fn right<M: Into<MigrationId> + Copy>(&self, row: M) -> Option<Position>

Return the right coordinate for a given row.

Returns

• Some(positions) if row is valid.
• None otherwise.

pub fn node<M: Into<MigrationId> + Copy>(&self, row: M) -> Option<NodeId>

Return the node for a given row.

Returns

• Some(node) if row is valid.
• None otherwise.

pub fn source<M: Into<MigrationId> + Copy>(&self, row: M) -> Option<PopulationId>

Return the source population for a given row.

Returns

• Some(population) if row is valid.
• None otherwise.

pub fn dest<M: Into<MigrationId> + Copy>(&self, row: M) -> Option<PopulationId>

Return the destination population for a given row.

Returns

• Some(population) if row is valid.
• None otherwise.

pub fn time<M: Into<MigrationId> + Copy>(&self, row: M) -> Option<Time>

Return the time of the migration event for a given row.

Returns

• Some(time) if row is valid.
• None otherwise.

pub fn metadata<T: MigrationMetadata>(
    &self,
    row: MigrationId
) -> Option<Result<T, TskitError>>

Retrieve decoded metadata for a row.

Returns

• Some(Ok(T)) if row is valid and decoding succeeded.
• Some(Err(_)) if row is not valid and decoding failed.
• None if row is not valid.

Errors

• TskitError::MetadataError if decoding fails.

Examples.

The big-picture semantics are the same for all table types. See crate::IndividualTable::metadata for examples.

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

Return an iterator over rows of the table. The value of the iterator is MigrationTableRow.

pub fn row<M: Into<MigrationId> + Copy>(&self, r: M) -> Option<MigrationTableRow>

Return row r of the table.

Parameters

• r: the row id.

Returns

• Some(row) if r is valid
• None otherwise