Function tskit::bindings::tsk_site_table_update_row

pub unsafe extern "C" fn tsk_site_table_update_row(
    self_: *mut tsk_site_table_t,
    index: tsk_id_t,
    position: f64,
    ancestral_state: *const c_char,
    ancestral_state_length: tsk_size_t,
    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. Copies of the ancestral_state and metadata parameters are taken immediately. See the :ref:table definition <sec_site_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_site_table_t object. @param index The row to update. @param position The position coordinate for the site. @param ancestral_state The ancestral_state for the site. @param ancestral_state_length The length of the ancestral_state in bytes. @param metadata The metadata to be associated with the site. 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.