Function tskit::bindings::tsk_table_collection_equals

pub unsafe extern "C" fn tsk_table_collection_equals(
    self_: *const tsk_table_collection_t, 
    other: *const tsk_table_collection_t, 
    options: tsk_flags_t
) -> bool

@brief Returns true if the data in the specified table collection is equal to the data in this table collection.

@rst

Returns true if the two table collections are equal. The indexes are not considered as these are derived from the tables. We also do not consider the file_uuid, since it is a property of the file that set of tables is stored in.

Options**

Options to control the comparison can be specified by providing one or more of the following bitwise flags. By default (options=0) two table collections are considered equal if all of the tables are byte-wise identical, and the sequence lengths, metadata and metadata schemas of the two table collections are identical.

TSK_CMP_IGNORE_PROVENANCE Do not include the provenance table in comparison. TSK_CMP_IGNORE_METADATA Do not include metadata when comparing the table collections. This includes both the top-level tree sequence metadata as well as the metadata for each of the tables (i.e, TSK_CMP_IGNORE_TS_METADATA is implied). All metadata schemas are also ignored. TSK_CMP_IGNORE_TS_METADATA Do not include the top-level tree sequence metadata and metadata schemas in the comparison. TSK_CMP_IGNORE_TIMESTAMPS Do not include the timestamp information when comparing the provenance tables. This has no effect if TSK_CMP_IGNORE_PROVENANCE is specified. @endrst

@param self A pointer to a tsk_table_collection_t object. @param other A pointer to a tsk_table_collection_t object. @param options Bitwise comparison options. @return Return true if the specified table collection is equal to this table.