tskit 0.16.0

rust interface to tskit
Documentation 
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

use std::ffi::c_char;
use std::ptr::NonNull;

use super::bindings::tsk_id_t;
use super::bindings::tsk_population_table_add_row;
use super::bindings::tsk_population_table_clear;
use super::bindings::tsk_population_table_init;
use super::bindings::tsk_population_table_t;
use super::tskbox::TskBox;
use super::TskitError;

#[derive(Debug)]
pub struct PopulationTable(TskBox<tsk_population_table_t>);

pub struct PopulationTableIter<'table> {
    table: &'table PopulationTable,
    current_row: super::newtypes::PopulationId,
}

impl<'table> Iterator for PopulationTableIter<'table> {
    type Item = super::Population<'table>;

    fn next(&mut self) -> Option<Self::Item> {
        let c = self.current_row;
        self.current_row += 1;
        self.table.row(c)
    }
}

impl PopulationTable {
    pub fn new(options: u32) -> Result<Self, TskitError> {
        let tsk = TskBox::new(|e: *mut tsk_population_table_t| unsafe {
            tsk_population_table_init(e, options)
        })?;
        Ok(Self(tsk))
    }

    pub unsafe fn new_borrowed(ptr: NonNull<tsk_population_table_t>) -> Self {
        let tsk = TskBox::new_init_from_ptr(ptr);
        Self(tsk)
    }

    pub fn as_ref(&self) -> &tsk_population_table_t {
        self.0.as_ref()
    }

    pub fn as_mut(&mut self) -> &mut tsk_population_table_t {
        self.0.as_mut()
    }

    pub fn clear(&mut self) -> i32 {
        unsafe { tsk_population_table_clear(self.as_mut()) }
    }

    pub fn add_row(&mut self) -> Result<tsk_id_t, TskitError> {
        self.add_row_with_metadata(&[])
    }

    pub fn add_row_with_metadata(&mut self, metadata: &[u8]) -> Result<tsk_id_t, TskitError> {
        unsafe {
            Ok(tsk_population_table_add_row(
                self.as_mut(),
                metadata.as_ptr().cast::<c_char>(),
                metadata.len() as u64,
            ))
        }
    }

    raw_metadata_getter_for_tables!(super::newtypes::PopulationId);

    pub fn row<'table>(
        &self,
        row: super::newtypes::PopulationId,
    ) -> Option<super::Population<'table>> {
        let mut population = unsafe {
            std::mem::MaybeUninit::<super::bindings::tsk_population_t>::zeroed().assume_init()
        };
        let rv = unsafe {
            super::bindings::tsk_population_table_get_row(
                self.as_ref(),
                row.into(),
                &mut population as *mut super::bindings::tsk_population_t,
            )
        };
        if rv == 0 {
            Some(super::Population {
                row: population,
                marker: std::marker::PhantomData,
            })
        } else {
            None
        }
    }

    pub fn iter(&self) -> impl Iterator<Item = super::Population<'_>> {
        PopulationTableIter {
            table: self,
            current_row: 0.into(),
        }
    }
}

impl Default for PopulationTable {
    fn default() -> Self {
        Self::new(0).unwrap()
    }
}