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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
use crate::bindings as ll_bindings;
use crate::metadata;
use crate::{tsk_flags_t, tsk_id_t, TskitError};
/// Row of a [`NodeTable`]
pub struct NodeTableRow {
pub id: tsk_id_t,
pub time: f64,
pub flags: tsk_flags_t,
pub population: tsk_id_t,
pub individual: tsk_id_t,
pub metadata: Option<Vec<u8>>,
}
impl PartialEq for NodeTableRow {
fn eq(&self, other: &Self) -> bool {
self.id == other.id
&& self.flags == other.flags
&& self.population == other.population
&& self.individual == other.individual
&& crate::util::f64_partial_cmp_equal(&self.time, &other.time)
&& self.metadata == other.metadata
}
}
fn make_node_table_row(
table: &NodeTable,
pos: tsk_id_t,
decode_metadata: bool,
) -> Option<NodeTableRow> {
if pos < table.num_rows() as tsk_id_t {
Some(NodeTableRow {
id: pos,
time: table.time(pos).unwrap(),
flags: table.flags(pos).unwrap(),
population: table.population(pos).unwrap(),
individual: table.individual(pos).unwrap(),
metadata: match decode_metadata {
true => match metadata_to_vector!(table, pos).unwrap() {
Some(x) => Some(x),
None => None,
},
false => None,
},
})
} else {
None
}
}
pub type NodeTableRefIterator<'a> = crate::table_iterator::TableIterator<&'a NodeTable<'a>>;
pub type NodeTableIterator<'a> = crate::table_iterator::TableIterator<NodeTable<'a>>;
impl<'a> Iterator for NodeTableRefIterator<'a> {
type Item = NodeTableRow;
fn next(&mut self) -> Option<Self::Item> {
let rv = make_node_table_row(self.table, self.pos, self.decode_metadata);
self.pos += 1;
rv
}
}
impl<'a> Iterator for NodeTableIterator<'a> {
type Item = crate::node_table::NodeTableRow;
fn next(&mut self) -> Option<Self::Item> {
let rv = make_node_table_row(&self.table, self.pos, self.decode_metadata);
self.pos += 1;
rv
}
}
/// 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!(self, row)?;
decode_metadata_row!(T, buffer)
}
/// Return an iterator over rows of the table.
/// The value of the iterator is [`NodeTableRow`].
///
/// # Parameters
///
/// * `decode_metadata`: if `true`, then a *copy* of row metadata
/// will be provided in [`NodeTableRow::metadata`].
/// The meta data are *not* decoded.
/// Rows with no metadata will contain the value `None`.
///
pub fn iter(&self, decode_metadata: bool) -> NodeTableRefIterator {
crate::table_iterator::make_table_iterator::<&NodeTable<'a>>(&self, decode_metadata)
}
/// Return row `r` of the table.
///
/// # Parameters
///
/// * `r`: the row id.
/// * `decode_metadata`: if `true`, then a *copy* of row metadata
/// will be provided in [`NodeTableRow::metadata`].
/// The meta data are *not* decoded.
/// Rows with no metadata will contain the value `None`.
///
/// # Errors
///
/// [`TskitError::IndexError`] if `r` is out of range.
pub fn row(&self, r: tsk_id_t, decode_metadata: bool) -> Result<NodeTableRow, TskitError> {
table_row_access!(r, decode_metadata, self, make_node_table_row)
}
/// Obtain a vector containing the indexes ("ids")
/// of all nodes for which [`crate::TSK_NODE_IS_SAMPLE`]
/// is `true`.
pub fn samples_as_vector(&self) -> Vec<tsk_id_t> {
let mut samples: Vec<tsk_id_t> = vec![];
for row in self.iter(false) {
if row.flags & crate::TSK_NODE_IS_SAMPLE > 0 {
samples.push(row.id);
}
}
samples
}
/// Obtain a vector containing the indexes ("ids") of all nodes
/// satisfying a certain criterion.
pub fn create_node_id_vector(
&self,
mut f: impl FnMut(&crate::NodeTableRow) -> bool,
) -> Vec<tsk_id_t> {
let mut samples: Vec<tsk_id_t> = vec![];
for row in self.iter(true) {
if f(&row) {
samples.push(row.id);
}
}
samples
}
}