feat: TableCollection::compute_mutation_parents

Author: molpopgen

src/sys/flags.rs

@@ -7,6 +7,8 @@ use crate::sys::bindings as ll_bindings;
 use crate::RawFlags;
 use bitflags::bitflags;
 
+use super::bindings::tsk_flags_t;
+
 macro_rules! impl_from_for_flag_types {
     ($flagstype: ty) => {
         impl From<$crate::RawFlags> for $flagstype {
@@ -746,6 +748,15 @@ impl From<RawFlags> for IndividualFlags {
     }
 }
 
+#[derive(Copy, Clone, Default, Debug)]
+pub struct MutationParentsFlags(tsk_flags_t);
+
+impl From<MutationParentsFlags> for tsk_flags_t {
+    fn from(value: MutationParentsFlags) -> Self {
+        value.0
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;

src/sys/table_collection.rs

@@ -1,3 +1,4 @@
+use super::bindings;
 use super::bindings::tsk_edge_table_t;
 use super::bindings::tsk_individual_table_t;
 use super::bindings::tsk_migration_table_t;
@@ -9,6 +10,7 @@ use super::bindings::tsk_provenance_table_t;
 use super::bindings::tsk_site_table_t;
 use super::bindings::tsk_table_collection_init;
 use super::bindings::tsk_table_collection_t;
+use super::flags::MutationParentsFlags;
 use super::tskbox::TskBox;
 use super::TskitError;
 
@@ -119,6 +121,20 @@ impl TableCollection {
     pub fn into_raw(self) -> *mut tsk_table_collection_t {
         self.0.into_raw()
     }
+
+    pub fn compute_mutation_parents(
+        &mut self,
+        options: MutationParentsFlags,
+    ) -> Result<(), TskitError> {
+        // SAFETY: as_mut_ptr is safe because the internal pointer cannot be null
+        let code = unsafe {
+            bindings::tsk_table_collection_compute_mutation_parents(
+                self.as_mut_ptr(),
+                options.into(),
+            )
+        };
+        handle_tsk_return_value!(code, ())
+    }
 }
 
 #[test]

src/table_collection.rs

@@ -1564,4 +1564,12 @@ impl TableCollection {
             Ok(Some(tables))
         }
     }
+
+    /// Compute the parents of each mutation.
+    pub fn compute_mutation_parents(
+        &mut self,
+        options: crate::MutationParentsFlags,
+    ) -> Result<(), TskitError> {
+        self.inner.compute_mutation_parents(options)
+    }
 }