Struct tskit::PopulationTable [−][src]
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>
[src]
impl<'a> PopulationTable<'a>
[src]pub fn num_rows(&'a self) -> tsk_size_t
[src]
Return the number of rows.
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<&'_ PopulationTable<'_>>
[src]
&self,
decode_metadata: bool
) -> TableIterator<&'_ PopulationTable<'_>>
Return an iterator over rows of the table.
The value of the iterator is PopulationTableRow
.
Parameters
decode_metadata
: iftrue
, then a copy of row metadata will be provided inPopulationTableRow::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<PopulationTableRow, TskitError>
[src]
&self,
r: tsk_id_t,
decode_metadata: bool
) -> Result<PopulationTableRow, TskitError>
Return row r
of the table.
Parameters
r
: the row id.decode_metadata
: iftrue
, then a copy of row metadata will be provided inPopulationTableRow::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 PopulationTable<'a>
impl<'a> RefUnwindSafe for PopulationTable<'a>
impl<'a> !Send for PopulationTable<'a>
impl<'a> !Send for PopulationTable<'a>
impl<'a> !Sync for PopulationTable<'a>
impl<'a> !Sync for PopulationTable<'a>
impl<'a> Unpin for PopulationTable<'a>
impl<'a> Unpin for PopulationTable<'a>
impl<'a> UnwindSafe for PopulationTable<'a>
impl<'a> UnwindSafe for PopulationTable<'a>