Struct tskit::EdgeTable

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

An immutable view of an edge table.

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

Implementations

impl<'a> EdgeTable<'a>

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

Return the number of rows

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

Return the parent value from row row of the table.

Errors

Will return IndexError if row is out of range.

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

Return the child value from row row of the table.

Errors

Will return IndexError if row is out of range.

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

Return the left value from row row of the table.

Errors

Will return IndexError if row is out of range.

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

Return the right value from row row of the table.

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<&'_ EdgeTable<'_>>

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

Parameters

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