Struct tskit::EdgeTable

#[repr(transparent)]
pub struct EdgeTable { /* private fields */ }

An immutable view of an edge table.

Implementations

impl EdgeTable

pub fn num_rows(&self) -> SizeType

Return the number of rows

pub fn parent<E: Into<EdgeId> + Copy>(&self, row: E) -> Option<NodeId>

Return the parent value from row row of the table.

Returns

• Some(parent) if u is valid.
• None otherwise.

pub fn child<E: Into<EdgeId> + Copy>(&self, row: E) -> Option<NodeId>

Return the child value from row row of the table.

Returns

• Some(child) if u is valid.
• None otherwise.

pub fn left<E: Into<EdgeId> + Copy>(&self, row: E) -> Option<Position>

Return the left value from row row of the table.

Returns

• Some(position) if u is valid.
• None otherwise.

pub fn right<E: Into<EdgeId> + Copy>(&self, row: E) -> Option<Position>

Return the right value from row row of the table.

Returns

• Some(position) if u is valid.
• None otherwise.

pub fn metadata<T: EdgeMetadata>( &self, row: EdgeId ) -> Option<Result<T, TskitError>>

Retrieve decoded metadata for a row.

Returns

• Some(Ok(T)) if row is valid and decoding succeeded.
• Some(Err(_)) if row is not valid and decoding failed.
• None if row is not valid.

Errors

• TskitError::MetadataError if decoding fails.

Examples.

The big-picture semantics are the same for all table types. See crate::IndividualTable::metadata for examples.

pub fn iter(&self) -> impl Iterator<Item = EdgeTableRow> + '_

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

pub fn lending_iter(&self) -> EdgeTableRowView<'_>

pub fn row<E: Into<EdgeId> + Copy>(&self, r: E) -> Option<EdgeTableRow>

Return row r of the table.

Parameters

• r: the row id.

Returns

• Some(row) if r is valid
• None otherwise

pub fn row_view<E: Into<EdgeId> + Copy>( &self, r: E ) -> Option<EdgeTableRowView<'_>>

Return a view of row r of the table.

Parameters

• r: the row id.

Returns

• Some(row_view) if r is valid
• None otherwise

pub fn left_slice(&self) -> &[Position]

Get the left column as a slice

pub fn left_slice_raw(&self) -> &[f64]

Get the left column as a slice of f64

pub fn right_slice(&self) -> &[Position]

Get the right column as a slice

pub fn right_slice_raw(&self) -> &[f64]

Get the left column as a slice of f64

pub fn parent_slice(&self) -> &[NodeId]

Get the parent column as a slice

pub fn parent_slice_raw(&self) -> &[tsk_id_t]

Get the parent column as a slice of crate::bindings::tsk_id_t

pub fn child_slice(&self) -> &[NodeId]

Get the child column as a slice

pub fn child_slice_raw(&self) -> &[tsk_id_t]

Get the child column as a slice of crate::bindings::tsk_id_t

Trait Implementations

impl Debug for EdgeTable

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.