Function tskit::bindings::tsk_table_collection_build_index
source · pub unsafe extern "C" fn tsk_table_collection_build_index(
self_: *mut tsk_table_collection_t,
options: tsk_flags_t
) -> c_int
Expand description
@brief Builds indexes for this table collection.
@rst
Builds the tree traversal :ref:indexes <sec_table_indexes>
for this table
collection. Any existing index is first dropped using
:c:func:tsk_table_collection_drop_index
. See the
:ref:sec_c_api_table_indexes
section for details on the index life-cycle.
@endrst
@param self A pointer to a tsk_table_collection_t object. @param options Bitwise options. Currently unused; should be set to zero to ensure compatibility with later versions of tskit. @return Return 0 on success or a negative value on failure.