Function tskit::bindings::tsk_migration_table_add_row [−][src]
pub unsafe extern "C" fn tsk_migration_table_add_row(
self_: *mut tsk_migration_table_t,
left: f64,
right: f64,
node: tsk_id_t,
source: tsk_id_t,
dest: tsk_id_t,
time: f64,
metadata: *const c_char,
metadata_length: tsk_size_t
) -> tsk_id_t
Expand description
@brief Adds a row to this migration table.
@rst
Add a new migration with the specified left
, right
, node
,
source
, dest
, time
and metadata
to the table.
See the :ref:table definition <sec_migration_table_definition>
for details of the columns in this table.
@endrst
@param self A pointer to a tsk_migration_table_t object.
@param left The left coordinate for the new migration.
@param right The right coordinate for the new migration.
@param node The node ID for the new migration.
@param source The source population ID for the new migration.
@param dest The destination population ID for the new migration.
@param time The time for the new migration.
@param metadata The metadata to be associated with the new migration. This
is a pointer to arbitrary memory. Can be NULL
if metadata_length
is 0.
@param metadata_length The size of the metadata array in bytes.
@return Return the ID of the newly added migration on success, or a negative value on failure.