migrations

Author: molpopgen

src/_macros.rs

@@ -931,6 +931,62 @@ macro_rules! site_table_add_row_with_metadata {
     };
 }
 
+macro_rules! migration_table_add_row_details {
+    ($span: ident,
+     $node: ident,
+     $source_dest: ident,
+     $time: ident,
+     $metadata: expr,
+     $metadata_len: expr,
+     $table: expr) => {{
+        let rv = unsafe {
+            $crate::bindings::tsk_migration_table_add_row(
+                &mut $table,
+                $span.0.into().0,
+                $span.1.into().0,
+                $node.into().0,
+                $source_dest.0.into().0,
+                $source_dest.1.into().0,
+                $time.into().0,
+                $metadata,
+                $metadata_len,
+            )
+        };
+        handle_tsk_return_value!(rv, rv.into())
+    }};
+}
+
+macro_rules! migration_table_add_row {
+    ($(#[$attr:meta])* => $name: ident, $self: ident, $table: expr) => {
+        $(#[$attr])*
+        pub fn $name(&mut $self,
+                     span: (impl Into<$crate::Position>, impl Into<$crate::Position>),
+                     node: impl Into<$crate::NodeId>,
+                     source_dest: (impl Into<$crate::PopulationId>, impl Into<$crate::PopulationId>),
+                     time: impl Into<$crate::Time>)
+        -> Result<$crate::MigrationId, $crate::TskitError> {
+            migration_table_add_row_details!(span, node, source_dest, time, std::ptr::null(), 0, $table)
+        }
+    };
+}
+
+macro_rules! migration_table_add_row_with_metadata {
+    ($(#[$attr:meta])* => $name: ident, $self: ident, $table: expr) => {
+        $(#[$attr])*
+        pub fn $name<M>(&mut $self,
+                        span: (impl Into<$crate::Position>, impl Into<$crate::Position>),
+                        node: impl Into<$crate::NodeId>,
+                        source_dest: (impl Into<$crate::PopulationId>, impl Into<$crate::PopulationId>),
+                        time: impl Into<$crate::Time>,
+                        metadata: &M)
+        -> Result<$crate::MigrationId, $crate::TskitError>
+        where M: $crate::metadata::MigrationMetadata {
+            let md = $crate::metadata::EncodedMetadata::new(metadata)?;
+            migration_table_add_row_details!(span, node, source_dest, time,
+                                             md.as_ptr(), md.len().into(), $table)
+        }
+    };
+}
 #[cfg(test)]
 mod test {
     use crate::error::TskitError;

src/table_collection.rs

@@ -1,7 +1,6 @@
 use crate::bindings as ll_bindings;
 use crate::error::TskitError;
 use crate::ffi::WrapTskitType;
-use crate::metadata::*;
 use crate::types::Bookmark;
 use crate::EdgeTable;
 use crate::IndividualTable;
@@ -19,12 +18,11 @@ use crate::TableEqualityOptions;
 use crate::TableIntegrityCheckFlags;
 use crate::TableOutputOptions;
 use crate::TableSortOptions;
-use crate::Time;
 use crate::TreeSequenceFlags;
 use crate::TskReturnValue;
 use crate::TskitTypeAccess;
 use crate::{tsk_id_t, tsk_size_t};
-use crate::{EdgeId, MigrationId, NodeId, PopulationId};
+use crate::{EdgeId, NodeId};
 use ll_bindings::tsk_table_collection_free;
 use mbox::MBox;
 
@@ -314,6 +312,7 @@ impl TableCollection {
     /// # }
     => add_individual_with_metadata, self, (*self.inner).individuals);
 
+    migration_table_add_row!(
     /// Add a row to the migration table
     ///
     /// # Warnings
@@ -329,36 +328,9 @@ impl TableCollection {
     ///                              (0, 1),
     ///                              53.5).is_ok());
     /// ```
-    pub fn add_migration<
-        L: Into<Position>,
-        R: Into<Position>,
-        N: Into<NodeId>,
-        SOURCE: Into<PopulationId>,
-        DEST: Into<PopulationId>,
-        T: Into<Time>,
-    >(
-        &mut self,
-        span: (L, R),
-        node: N,
-        source_dest: (SOURCE, DEST),
-        time: T,
-    ) -> Result<MigrationId, TskitError> {
-        let rv = unsafe {
-            ll_bindings::tsk_migration_table_add_row(
-                &mut (*self.as_mut_ptr()).migrations,
-                span.0.into().0,
-                span.1.into().0,
-                node.into().0,
-                source_dest.0.into().0,
-                source_dest.1.into().0,
-                time.into().0,
-                std::ptr::null(),
-                0,
-            )
-        };
-        handle_tsk_return_value!(rv, MigrationId(rv))
-    }
+    => add_migration, self, (*self.inner).migrations);
 
+    migration_table_add_row_with_metadata!(
     /// Add a row with optional metadata to the migration table
     ///
     /// # Examples
@@ -388,38 +360,7 @@ impl TableCollection {
     ///
     /// Migration tables are not currently supported
     /// by tree sequence simplification.
-    pub fn add_migration_with_metadata<
-        L: Into<Position>,
-        R: Into<Position>,
-        N: Into<NodeId>,
-        SOURCE: Into<PopulationId>,
-        DEST: Into<PopulationId>,
-        MD: MigrationMetadata,
-        T: Into<Time>,
-    >(
-        &mut self,
-        span: (L, R),
-        node: N,
-        source_dest: (SOURCE, DEST),
-        time: T,
-        metadata: &MD,
-    ) -> Result<MigrationId, TskitError> {
-        let md = EncodedMetadata::new(metadata)?;
-        let rv = unsafe {
-            ll_bindings::tsk_migration_table_add_row(
-                &mut (*self.as_mut_ptr()).migrations,
-                span.0.into().0,
-                span.1.into().0,
-                node.into().0,
-                source_dest.0.into().0,
-                source_dest.1.into().0,
-                time.into().0,
-                md.as_ptr(),
-                md.len().into(),
-            )
-        };
-        handle_tsk_return_value!(rv, MigrationId(rv))
-    }
+    => add_migration_with_metadata, self, (*self.inner).migrations);
 
     node_table_add_row!(
     /// Add a row to the node table
@@ -970,6 +911,7 @@ impl crate::traits::NodeListGenerator for TableCollection {}
 #[cfg(test)]
 mod test {
     use super::*;
+    use crate::metadata::*;
     use crate::prelude::*;
     use crate::NodeFlags;