Function tskit::bindings::tsk_migration_table_copy
source · pub unsafe extern "C" fn tsk_migration_table_copy(
self_: *const tsk_migration_table_t,
dest: *mut tsk_migration_table_t,
options: tsk_flags_t
) -> c_int
Expand description
@brief Copies the state of this table into the specified destination.
@rst
By default the method initialises the specified destination table. If the
destination is already initialised, the :c:macro:TSK_NO_INIT
option should
be supplied to avoid leaking memory.
@endrst
@param self A pointer to a tsk_migration_table_t object. @param dest A pointer to a tsk_migration_table_t object. If the TSK_NO_INIT option is specified, this must be an initialised migration table. If not, it must be an uninitialised migration table. @param options Bitwise option flags. @return Return 0 on success or a negative value on failure.