Struct tskit::NodeTable

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

An immtable view of a node table.

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

Implementations

impl<'a> NodeTable<'a>

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

Return the number of rows

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

Return the time value from row row of the table.

Errors

Will return IndexError if row is out of range.

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

Return the flags value from row row of the table.

Errors

Will return IndexError if row is out of range.

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

Return the population value from row row of the table.

Errors

Will return IndexError if row is out of range.

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

Return the population value from row row of the table.

Errors

Will return IndexError if row is out of range.

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

Return the individual 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<&'_ NodeTable<'_>>

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

Parameters

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

pub fn samples_as_vector(&self) -> Vec<tsk_id_t>

Obtain a vector containing the indexes (“ids”) of all nodes for which crate::TSK_NODE_IS_SAMPLE is true.

pub fn create_node_id_vector(
    &self,
    f: impl FnMut(&NodeTableRow) -> bool
) -> Vec<tsk_id_t>

Obtain a vector containing the indexes (“ids”) of all nodes satisfying a certain criterion.