Struct tskit::NodeTable [−][src]
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>
[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]
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]
Return the flags
value from row row
of the table.
Errors
Will return IndexError
if row
is out of range.
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]
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]
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, decode_metadata: bool) -> TableIterator<&'_ NodeTable<'_>>
[src]
Return an iterator over rows of the table.
The value of the iterator is NodeTableRow
.
Parameters
decode_metadata
: iftrue
, then a copy of row metadata will be provided inNodeTableRow::metadata
. The meta data are not decoded. Rows with no metadata will contain the valueNone
.
pub fn row(
&self,
r: tsk_id_t,
decode_metadata: bool
) -> Result<NodeTableRow, TskitError>
[src]
&self,
r: tsk_id_t,
decode_metadata: bool
) -> Result<NodeTableRow, TskitError>
Return row r
of the table.
Parameters
r
: the row id.decode_metadata
: iftrue
, then a copy of row metadata will be provided inNodeTableRow::metadata
. The meta data are not decoded. Rows with no metadata will contain the valueNone
.
Errors
TskitError::IndexError
if r
is out of range.
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]
&self,
f: impl FnMut(&NodeTableRow) -> bool
) -> Vec<tsk_id_t>
Obtain a vector containing the indexes (“ids”) of all nodes satisfying a certain criterion.
Auto Trait Implementations
impl<'a> RefUnwindSafe for NodeTable<'a>
impl<'a> !Send for NodeTable<'a>
impl<'a> !Sync for NodeTable<'a>
impl<'a> Unpin for NodeTable<'a>
impl<'a> UnwindSafe for NodeTable<'a>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,