Struct tskit::SiteTable [−][src]
pub struct SiteTable<'a> { /* fields omitted */ }Expand description
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>[src]
impl<'a> SiteTable<'a>[src]pub fn num_rows(&'a self) -> tsk_size_t[src]
pub fn num_rows(&'a self) -> tsk_size_t[src]Return the number of rows
pub fn position(&'a self, row: tsk_id_t) -> Result<f64, TskitError>[src]
pub fn position(&'a self, row: tsk_id_t) -> Result<f64, TskitError>[src]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>[src]
pub fn ancestral_state(
&'a self,
row: tsk_id_t
) -> Result<Option<Vec<u8>>, TskitError>[src]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>[src]
&'a self,
row: tsk_id_t
) -> Result<Option<T>, TskitError>
pub fn iter(&self) -> TableIterator<&'_ SiteTable<'_>>[src]
pub fn iter(&self) -> TableIterator<&'_ SiteTable<'_>>[src]Return an iterator over rows of the table.
The value of the iterator is SiteTableRow.
pub fn row(&self, r: tsk_id_t) -> Result<SiteTableRow, TskitError>[src]
pub fn row(&self, r: tsk_id_t) -> Result<SiteTableRow, TskitError>[src]Return row r of the table.
Parameters
r: the row id.
Errors
TskitError::IndexError if r is out of range.