Struct tskit::MigrationTable[−][src]

pub struct MigrationTable<'a> { /* fields omitted */ }

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]

pub fn num_rows(&'a self) -> tsk_size_t[src]

Return the number of rows

pub fn left(&'a self, row: tsk_id_t) -> Result<f64, TskitError>[src]

Return the left coordinate for a given row.

Errors

pub fn right(&'a self, row: tsk_id_t) -> Result<f64, TskitError>[src]

Return the right coordinate for a given row.

Errors

pub fn node(&'a self, row: tsk_id_t) -> Result<tsk_id_t, TskitError>[src]

Return the node for a given row.

Errors

pub fn source(&'a self, row: tsk_id_t) -> Result<tsk_id_t, TskitError>[src]

Return the source population for a given row.

Errors

pub fn dest(&'a self, row: tsk_id_t) -> Result<tsk_id_t, TskitError>[src]

Return the destination population for a given row.

Errors

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

pub fn metadata<T: MetadataRoundtrip>(
    &'a self,
    row: tsk_id_t
) -> Result<Option<T>, TskitError>[src]

Return the metadata for a given row.

Errors

pub fn iter(
    &self,
    decode_metadata: bool
) -> TableIterator<&'_ MigrationTable<'_>>[src]

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

Parameters

  • decode_metadata: if true, then a copy of row metadata will be provided in MigrationTableRow::metadata. The meta data are not decoded. Rows with no metadata will contain the value None.

pub fn row(
    &self,
    r: tsk_id_t,
    decode_metadata: bool
) -> Result<MigrationTableRow, TskitError>[src]

Return row r of the table.

Parameters

  • r: the row id.
  • decode_metadata: if true, then a copy of row metadata will be provided in MigrationTableRow::metadata. The meta data are not decoded. Rows with no metadata will contain the value None.

Errors

TskitError::IndexError if r is out of range.

Auto Trait Implementations

impl<'a> RefUnwindSafe for MigrationTable<'a>

impl<'a> !Send for MigrationTable<'a>

impl<'a> !Sync for MigrationTable<'a>

impl<'a> Unpin for MigrationTable<'a>

impl<'a> UnwindSafe for MigrationTable<'a>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.