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
Return the number of rows
Return the position
value from row row
of the table.
Errors
Will return IndexError
if row
is out of range.
pub fn ancestral_state<S: Into<SiteId>>(
&'a self,
row: S
) -> Result<Option<Vec<u8>>, TskitError>
pub fn ancestral_state<S: Into<SiteId>>(
&'a self,
row: S
) -> 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.
Return an iterator over rows of the table.
The value of the iterator is SiteTableRow
.
Return row r
of the table.
Parameters
r
: the row id.
Errors
TskitError::IndexError
if r
is out of range.