Struct tskit::NodeTable [−][src]
pub struct NodeTable<'a> { /* fields omitted */ }
Expand description
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>
[src]
impl<'a> NodeTable<'a>
[src]pub fn num_rows(&'a self) -> tsk_size_t
[src]
pub fn num_rows(&'a self) -> tsk_size_t
[src]Return the number of rows
pub fn time(&'a self, row: tsk_id_t) -> Result<f64, TskitError>
[src]
pub fn time(&'a self, row: tsk_id_t) -> Result<f64, TskitError>
[src]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>
[src]
pub fn flags(&'a self, row: tsk_id_t) -> Result<tsk_flags_t, TskitError>
[src]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]
[src]
pub fn flags_array_mut(&mut self) -> &mut [tsk_flags_t]
[src]Mutable access to node flags.
pub fn time_array_mut(&mut self) -> &mut [f64]
[src]
pub fn time_array_mut(&mut self) -> &mut [f64]
[src]Mutable access to node times.
pub fn population(&'a self, row: tsk_id_t) -> Result<tsk_id_t, TskitError>
[src]
pub fn population(&'a self, row: tsk_id_t) -> Result<tsk_id_t, TskitError>
[src]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>
[src]
pub fn deme(&'a self, row: tsk_id_t) -> Result<tsk_id_t, TskitError>
[src]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>
[src]
pub fn individual(&'a self, row: tsk_id_t) -> Result<tsk_id_t, TskitError>
[src]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>
[src]
&'a self,
row: tsk_id_t
) -> Result<Option<T>, TskitError>
pub fn iter(&self) -> TableIterator<&'_ NodeTable<'_>>
[src]
pub fn iter(&self) -> TableIterator<&'_ NodeTable<'_>>
[src]Return an iterator over rows of the table.
The value of the iterator is NodeTableRow
.
pub fn row(&self, r: tsk_id_t) -> Result<NodeTableRow, TskitError>
[src]
pub fn row(&self, r: tsk_id_t) -> Result<NodeTableRow, TskitError>
[src]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<tsk_id_t>
[src]
pub fn samples_as_vector(&self) -> Vec<tsk_id_t>
[src]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>
[src]
pub fn create_node_id_vector(
&self,
f: impl FnMut(&NodeTableRow) -> bool
) -> Vec<tsk_id_t>
[src]Obtain a vector containing the indexes (“ids”) of all nodes satisfying a certain criterion.