Struct tskit::SiteTable

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

An immutable view of site table.

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

Implementations

impl<'a> SiteTable<'a>

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

Return the number of rows

pub fn position(&'a self, row: tsk_id_t) -> Result<f64, TskitError>

Return the position value from row row of the table.

Errors

Will return IndexError if row is out of range.

pub fn ancestral_state(
    &'a self,
    row: tsk_id_t
) -> Result<Option<Vec<u8>>, TskitError>

Get the ancestral_state value from row row of the table.

Return

Will return None if there is no ancestral state.

Errors

Will return IndexError if row is out of range.

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

pub fn iter(&self, decode_metadata: bool) -> TableIterator<&'_ SiteTable<'_>>

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

Parameters

• decode_metadata: if true, then a copy of row metadata will be provided in SiteTableRow::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<SiteTableRow, TskitError>

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 SiteTableRow::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.