Struct tskit::IndividualTable

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

An immutable view of a individual table.

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

Implementations

impl<'a> IndividualTable<'a>

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

Return the number of rows

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

Return the flags for a given row.

Errors

• TskitError::IndexError if row is out of range.

pub fn location(&self, row: tsk_id_t) -> Result<Option<Vec<f64>>, TskitError>

Return the locations for a given row.

Errors

• TskitError::IndexError if row is out of range.

pub fn parents(
    &self,
    row: tsk_id_t
) -> Result<Option<Vec<tsk_id_t>>, TskitError>

Return the parents for a given row.

Errors

• TskitError::IndexError if row is out of range.

pub fn metadata<T: MetadataRoundtrip>(
    &'a self,
    row: tsk_id_t
) -> Result<Option<T>, TskitError>

Return the metadata for a given row.

Errors

• TskitError::IndexError if row is out of range.

pub fn iter(
    &self,
    decode_metadata: bool
) -> TableIterator<&'_ IndividualTable<'_>>

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

Parameters

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