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<N: Into<NodeId> + Copy>(&'a self, row: N) -> 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<N: Into<NodeId> + Copy>(
    &'a self,
    row: N
) -> 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 flags_array_mut(&mut self) -> &mut [tsk_flags_t]

Mutable access to node flags.

pub fn time_array_mut(&mut self) -> &mut [f64]

Mutable access to node times.

pub fn population<N: Into<NodeId> + Copy>(
    &'a self,
    row: N
) -> Result<PopulationId, TskitError>

Return the population value from row row of the table.

Errors

Will return IndexError if row is out of range.

pub fn deme<N: Into<NodeId> + Copy>(
    &'a self,
    row: N
) -> Result<PopulationId, TskitError>

Return the population value from row row of the table.

Errors

Will return IndexError if row is out of range.

pub fn individual<N: Into<NodeId> + Copy>(
    &'a self,
    row: N
) -> Result<IndividualId, 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: NodeId
) -> Result<Option<T>, TskitError>

pub fn iter(&self) -> TableIterator<&'_ NodeTable<'_>>

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

pub fn row<N: Into<NodeId> + Copy>(
    &self,
    r: N
) -> Result<NodeTableRow, TskitError>

Return row r of the table.

Parameters

• r: the row id.

Errors

TskitError::IndexError if r is out of range.

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

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<NodeId>

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