Struct tskit::OwnedEdgeTable

pub struct OwnedEdgeTable { /* private fields */ }

A standalone edge table that owns its data.

Examples

use tskit::OwnedEdgeTable;

let mut edges = OwnedEdgeTable::default();
let rowid = edges.add_row(1., 2., 0, 1).unwrap();
assert_eq!(rowid, 0);
assert_eq!(edges.num_rows(), 1);

edges.clear().unwrap();
assert_eq!(edges.num_rows(), 0);

An example with metadata. This requires the cargo feature "derive" for tskit.

use tskit::OwnedEdgeTable;

#[derive(serde::Serialize,
         serde::Deserialize,
         tskit::metadata::EdgeMetadata)]
#[serializer("serde_json")]
struct EdgeMetadata {
    value: i32,
}

let metadata = EdgeMetadata{value: 42};

let mut edges = OwnedEdgeTable::default();

let rowid = edges.add_row_with_metadata(0., 1., 5, 10, &metadata).unwrap();
assert_eq!(rowid, 0);

match edges.metadata::<EdgeMetadata>(rowid) {
    // rowid is in range, decoding succeeded
    Some(Ok(decoded)) => assert_eq!(decoded.value, 42),
    // rowid is in range, decoding failed
    Some(Err(e)) => panic!("error decoding metadata: {:?}", e),
    None => panic!("row id out of range")
}

Implementations

impl OwnedEdgeTable

pub fn clear(&mut self) -> TskReturnValue

Clear the table.

impl OwnedEdgeTable

pub fn as_ptr(&self) -> *const tsk_edge_table_t

pub fn as_mut_ptr(&mut self) -> *mut tsk_edge_table_t

impl OwnedEdgeTable

pub fn add_row<L, R, P, C>(
    &mut self,
    left: L,
    right: R,
    parent: P,
    child: C
) -> Result<EdgeId, TskitError>where
    L: Into<Position>,
    R: Into<Position>,
    P: Into<NodeId>,
    C: Into<NodeId>,

pub fn add_row_with_metadata<L, R, P, C, M>(
    &mut self,
    left: L,
    right: R,
    parent: P,
    child: C,
    metadata: &M
) -> Result<EdgeId, TskitError>where
    L: Into<Position>,
    R: Into<Position>,
    P: Into<NodeId>,
    C: Into<NodeId>,
    M: EdgeMetadata,

Methods from Deref<Target = 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 Default for OwnedEdgeTable

fn default() -> Self

Returns the “default value” for a type.

impl Deref for OwnedEdgeTable

type Target = EdgeTable

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for OwnedEdgeTable

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Drop for OwnedEdgeTable

fn drop(&mut self)

Executes the destructor for this type.