Struct MigrationTable 

pub struct MigrationTable { /* private fields */ }

A migration table.

Examples

use tskit::MigrationTable;

let mut migrations = MigrationTable::default();
let rowid = migrations.add_row((0., 1.), 1, (0, 1), 10.3).unwrap();
assert_eq!(rowid, 0);
assert_eq!(migrations.num_rows(), 1);

An example with metadata. This requires the cargo feature "derive" for tskit.

use tskit::MigrationTable;

#[derive(serde::Serialize,
         serde::Deserialize,
         tskit::metadata::MigrationMetadata)]
#[serializer("serde_json")]
struct MigrationMetadata {
    value: i32,
}

let metadata = MigrationMetadata{value: 42};

let mut migrations = MigrationTable::default();

let rowid = migrations.add_row_with_metadata((0., 1.), 1, (0, 1), 10.3, &metadata).unwrap();
assert_eq!(rowid, 0);

match migrations.metadata::<MigrationMetadata>(rowid) {
    // rowid is in range, decoding succeeded
    Some(Ok(decoded)) => assert_eq!(decoded.value, 42),
    // rowid is in range, decoding failed
    Some(Err(e)) => panic!("error decoding metadata: {:?}", e),
    None => panic!("row id out of range")
}

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: impl Into<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 valid and decoding failed.
• None if row is not valid or the row has no metadata.

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 lending_iter(&self) -> MigrationTableRowView<'_>

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

pub fn row_view<M: Into<MigrationId> + Copy>( &self, r: M, ) -> Option<MigrationTableRowView<'_>>

Return a view of r of the table.

Parameters

• r: the row id.

Returns

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

pub fn left_slice(&self) -> &[Position]

Get the left column as a slice

pub fn left_slice_raw(&self) -> &[f64]

Get the left column as a slice

pub fn right_slice(&self) -> &[Position]

Get the right column as a slice

pub fn right_slice_raw(&self) -> &[f64]

Get the right column as a slice

pub fn time_slice(&self) -> &[Time]

Get the time column as a slice

pub fn time_slice_raw(&self) -> &[f64]

Get the time column as a slice

pub fn node_slice(&self) -> &[NodeId]

Get the node column as a slice

pub fn node_slice_raw(&self) -> &[tsk_id_t]

Get the node column as a slice

pub fn source_slice(&self) -> &[PopulationId]

Get the source column as a slice

pub fn source_slice_raw(&self) -> &[tsk_id_t]

Get the source column as a slice

pub fn dest_slice(&self) -> &[PopulationId]

Get the dest column as a slice

pub fn dest_slice_raw(&self) -> &[tsk_id_t]

Get the dest column as a slice

pub fn left_column(&self) -> impl TableColumn<MigrationId, Position> + '_

pub fn right_column(&self) -> impl TableColumn<MigrationId, Position> + '_

pub fn node_column(&self) -> impl TableColumn<MigrationId, NodeId> + '_

pub fn time_column(&self) -> impl TableColumn<MigrationId, Time> + '_

pub fn source_column(&self) -> impl TableColumn<MigrationId, PopulationId> + '_

pub fn dest_column(&self) -> impl TableColumn<MigrationId, PopulationId> + '_

pub fn clear(&mut self) -> Result<i32, TskitError>

Clear all data from the table

pub fn add_row<LEFT, RIGHT, N, SOURCE, DEST, T>( &mut self, span: (LEFT, RIGHT), node: N, source_dest: (SOURCE, DEST), time: T, ) -> Result<MigrationId, TskitError>

where LEFT: Into<Position>, RIGHT: Into<Position>, N: Into<NodeId>, SOURCE: Into<PopulationId>, DEST: Into<PopulationId>, T: Into<Time>,

pub fn add_row_with_metadata<LEFT, RIGHT, N, SOURCE, DEST, T, M>( &mut self, span: (LEFT, RIGHT), node: N, source_dest: (SOURCE, DEST), time: T, metadata: &M, ) -> Result<MigrationId, TskitError>

where LEFT: Into<Position>, RIGHT: Into<Position>, N: Into<NodeId>, SOURCE: Into<PopulationId>, DEST: Into<PopulationId>, T: Into<Time>, M: MigrationMetadata,

Trait Implementations

impl Debug for MigrationTable

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

Formats the value using the given formatter.

impl Default for MigrationTable

fn default() -> MigrationTable

Returns the “default value” for a type.