Struct MutationTable

pub struct MutationTable<'a> { /* private fields */ }

An immutable view of site table.

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

Implementations

impl<'a> MutationTable<'a>

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

Return the number of rows.

pub fn site(&'a self, row: tsk_id_t) -> Result<tsk_id_t, TskitRustError>

Return the site value from row row of the table.

Errors

Will return IndexError if row is out of range.

pub fn node(&'a self, row: tsk_id_t) -> Result<tsk_id_t, TskitRustError>

Return the node value from row row of the table.

Errors

Will return IndexError if row is out of range.

pub fn parent(&'a self, row: tsk_id_t) -> Result<tsk_id_t, TskitRustError>

Return the parent value from row row of the table.

Errors

Will return IndexError if row is out of range.

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

Return the time value from row row of the table.

Errors

Will return IndexError if row is out of range.

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

Get the derived_state value from row row of the table.

Return

Will return None if there is no derived state.

Errors

Will return IndexError if row is out of range.