Function tskit::bindings::tsk_table_collection_canonicalise

pub unsafe extern "C" fn tsk_table_collection_canonicalise(
    self_: *mut tsk_table_collection_t, 
    options: tsk_flags_t
) -> c_int

@brief Puts the tables into canonical form.

@rst Put tables into canonical form such that randomly reshuffled tables are guaranteed to always be sorted in the same order, and redundant information is removed. The canonical sorting exceeds the usual tree sequence sortedness requirements.

Options**:

Options can be specified by providing one or more of the following bitwise flags:

TSK_KEEP_UNREFERENCED By default, this will remove any unreferenced sites, populations, and individuals. If this flag is provided, these will be retained, with unreferenced individuals and populations at the end of the tables, in their original order.

@endrst

@return Return 0 on success or a negative value on failure.