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]
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]
pub fn right(&'a self, row: tsk_id_t) -> Result<f64, TskitError>
[src]
pub fn node(&'a self, row: tsk_id_t) -> Result<tsk_id_t, TskitError>
[src]
pub fn source(&'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::IndexError
ifrow
is out of range.
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::IndexError
ifrow
is out of range.
pub fn metadata<T: MetadataRoundtrip>(
&'a self,
row: tsk_id_t
) -> Result<Option<T>, TskitError>
[src]
&'a self,
row: tsk_id_t
) -> Result<Option<T>, TskitError>
pub fn iter(
&self,
decode_metadata: bool
) -> TableIterator<&'_ MigrationTable<'_>>
[src]
&self,
decode_metadata: bool
) -> TableIterator<&'_ MigrationTable<'_>>
Return an iterator over rows of the table.
The value of the iterator is MigrationTableRow
.
Parameters
decode_metadata
: iftrue
, then a copy of row metadata will be provided inMigrationTableRow::metadata
. The meta data are not decoded. Rows with no metadata will contain the valueNone
.
pub fn row(
&self,
r: tsk_id_t,
decode_metadata: bool
) -> Result<MigrationTableRow, TskitError>
[src]
&self,
r: tsk_id_t,
decode_metadata: bool
) -> Result<MigrationTableRow, TskitError>
Return row r
of the table.
Parameters
r
: the row id.decode_metadata
: iftrue
, then a copy of row metadata will be provided inMigrationTableRow::metadata
. The meta data are not decoded. Rows with no metadata will contain the valueNone
.
Errors
TskitError::IndexError
if r
is out of range.
Auto Trait Implementations
impl<'a> RefUnwindSafe for MigrationTable<'a>
impl<'a> RefUnwindSafe for MigrationTable<'a>
impl<'a> !Send for MigrationTable<'a>
impl<'a> !Send for MigrationTable<'a>
impl<'a> !Sync for MigrationTable<'a>
impl<'a> !Sync for MigrationTable<'a>
impl<'a> Unpin for MigrationTable<'a>
impl<'a> Unpin for MigrationTable<'a>
impl<'a> UnwindSafe for MigrationTable<'a>
impl<'a> UnwindSafe for MigrationTable<'a>