Function tskit::bindings::tsk_migration_table_update_row

pub unsafe extern "C" fn tsk_migration_table_update_row(
    self_: *mut tsk_migration_table_t,
    index: tsk_id_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
) -> c_int

@brief Updates the row at the specified index.

@rst Rewrite the row at the specified index in this table to use the specified values. A copy of the metadata parameter is taken immediately. See the :ref:table definition <sec_migration_table_definition> for details of the columns in this table.

.. warning:: Because of the way that ragged columns are encoded, this method requires a full rewrite of the internal column memory in worst case, and would therefore be inefficient for bulk updates for such columns. However, if the sizes of all ragged column values are unchanged in the updated row, this method is guaranteed to only update the memory for the row in question. @endrst

@param self A pointer to a tsk_migration_table_t object. @param index The row to update. @param left The left coordinate for the migration. @param right The right coordinate for the migration. @param node The node ID for the migration. @param source The source population ID for the migration. @param dest The destination population ID for the migration. @param time The time for the migration. @param metadata The metadata to be associated with the 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 0 on success or a negative value on failure.