Struct tskit::PopulationTable

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

An immutable view of site table.

These are not created directly. Instead, use TableCollection::populations to get a reference to an existing population table;

Implementations

impl<'a> PopulationTable<'a>

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

Return the number of rows.

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

pub fn iter(&self) -> TableIterator<&'_ PopulationTable<'_>>

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

pub fn row<P: Into<PopulationId> + Copy>(
    &self,
    r: P
) -> Result<PopulationTableRow, TskitError>

Return row r of the table.

Parameters

• r: the row id.

Errors

TskitError::IndexError if r is out of range.