Function tskit::bindings::tsk_mutation_table_add_row
source · pub unsafe extern "C" fn tsk_mutation_table_add_row(
self_: *mut tsk_mutation_table_t,
site: tsk_id_t,
node: tsk_id_t,
parent: tsk_id_t,
time: f64,
derived_state: *const c_char,
derived_state_length: tsk_size_t,
metadata: *const c_char,
metadata_length: tsk_size_t
) -> tsk_id_t
Expand description
@brief Adds a row to this mutation table.
@rst
Add a new mutation with the specified site
, parent
, derived_state
and metadata
to the table. Copies of derived_state
and metadata
are immediately taken. See the :ref:table definition <sec_mutation_table_definition>
for details of the columns in this table.
@endrst
@param self A pointer to a tsk_mutation_table_t object.
@param site The site ID for the new mutation.
@param node The ID of the node this mutation occurs over.
@param parent The ID of the parent mutation.
@param time The time of the mutation.
@param derived_state The derived_state for the new mutation.
@param derived_state_length The length of the derived_state in bytes.
@param metadata The metadata to be associated with the new mutation. 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 mutation on success,
or a negative value on failure.