Struct tskit::MutationTable [−][src]
pub struct MutationTable<'a> { /* fields omitted */ }
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>
[src]
impl<'a> MutationTable<'a>
[src]pub fn num_rows(&'a self) -> tsk_size_t
[src]
Return the number of rows.
pub fn site(&'a self, row: tsk_id_t) -> Result<tsk_id_t, TskitError>
[src]
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, TskitError>
[src]
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, TskitError>
[src]
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, TskitError>
[src]
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>>, TskitError>
[src]
&'a self,
row: tsk_id_t
) -> Result<Option<Vec<u8>>, TskitError>
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.
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<&'_ MutationTable<'_>>
[src]
&self,
decode_metadata: bool
) -> TableIterator<&'_ MutationTable<'_>>
Return an iterator over rows of the table.
The value of the iterator is MutationTableRow
.
Parameters
decode_metadata
: iftrue
, then a copy of row metadata will be provided inMutationTableRow::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<MutationTableRow, TskitError>
[src]
&self,
r: tsk_id_t,
decode_metadata: bool
) -> Result<MutationTableRow, TskitError>
Return row r
of the table.
Parameters
r
: the row id.decode_metadata
: iftrue
, then a copy of row metadata will be provided inMutationTableRow::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 MutationTable<'a>
impl<'a> RefUnwindSafe for MutationTable<'a>
impl<'a> !Send for MutationTable<'a>
impl<'a> !Send for MutationTable<'a>
impl<'a> !Sync for MutationTable<'a>
impl<'a> !Sync for MutationTable<'a>
impl<'a> Unpin for MutationTable<'a>
impl<'a> Unpin for MutationTable<'a>
impl<'a> UnwindSafe for MutationTable<'a>
impl<'a> UnwindSafe for MutationTable<'a>