1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
use crate::bindings as ll_bindings;
use crate::metadata;
use crate::{tsk_flags_t, tsk_id_t, TskitError};
/// An immtable view of a node table.
///
/// These are not created directly.
/// Instead, use [`TableCollection::nodes`](crate::TableCollection::nodes)
/// to get a reference to an existing node table;
pub struct NodeTable<'a> {
table_: &'a ll_bindings::tsk_node_table_t,
}
impl<'a> NodeTable<'a> {
pub(crate) fn new_from_table(nodes: &'a ll_bindings::tsk_node_table_t) -> Self {
NodeTable { table_: nodes }
}
/// Return the number of rows
pub fn num_rows(&'a self) -> ll_bindings::tsk_size_t {
self.table_.num_rows
}
/// Return the ``time`` value from row ``row`` of the table.
///
/// # Errors
///
/// Will return [``IndexError``](crate::TskitError::IndexError)
/// if ``row`` is out of range.
pub fn time(&'a self, row: tsk_id_t) -> Result<f64, TskitError> {
unsafe_tsk_column_access!(row, 0, self.num_rows(), self.table_.time)
}
/// Return the ``flags`` value from row ``row`` of the table.
///
/// # Errors
///
/// Will return [``IndexError``](crate::TskitError::IndexError)
/// if ``row`` is out of range.
pub fn flags(&'a self, row: tsk_id_t) -> Result<tsk_flags_t, TskitError> {
unsafe_tsk_column_access!(row, 0, self.num_rows(), self.table_.flags)
}
/// Return the ``population`` value from row ``row`` of the table.
///
/// # Errors
///
/// Will return [``IndexError``](crate::TskitError::IndexError)
/// if ``row`` is out of range.
pub fn population(&'a self, row: tsk_id_t) -> Result<tsk_id_t, TskitError> {
unsafe_tsk_column_access!(row, 0, self.num_rows(), self.table_.population)
}
/// Return the ``population`` value from row ``row`` of the table.
///
/// # Errors
///
/// Will return [``IndexError``](crate::TskitError::IndexError)
/// if ``row`` is out of range.
pub fn deme(&'a self, row: tsk_id_t) -> Result<tsk_id_t, TskitError> {
self.population(row)
}
/// Return the ``individual`` value from row ``row`` of the table.
///
/// # Errors
///
/// Will return [``IndexError``](crate::TskitError::IndexError)
/// if ``row`` is out of range.
pub fn individual(&'a self, row: tsk_id_t) -> Result<tsk_id_t, TskitError> {
unsafe_tsk_column_access!(row, 0, self.num_rows(), self.table_.individual)
}
pub fn metadata<T: metadata::MetadataRoundtrip>(
&'a self,
row: tsk_id_t,
) -> Result<Option<T>, TskitError> {
let buffer = metadata_to_vector!(T, self, row);
decode_metadata_row!(T, buffer)
}
}