Function tskit::bindings::tsk_population_table_extend
source · pub unsafe extern "C" fn tsk_population_table_extend(
self_: *mut tsk_population_table_t,
other: *const tsk_population_table_t,
num_rows: tsk_size_t,
row_indexes: *const tsk_id_t,
options: tsk_flags_t
) -> c_int
Expand description
@brief Extends this table by appending rows copied from another table.
@rst
Appends the rows at the specified indexes from the table other
to the end of this
table. Row indexes can be repeated and in any order. If row_indexes
is NULL, append
the first num_rows
from other
to this table. Note that metadata is copied as-is
and is not checked for compatibility with any existing schema on this table.
@endrst
@param self A pointer to a tsk_population_table_t object where rows are to be added.
@param other A pointer to a tsk_population_table_t object where rows are copied from.
@param num_rows The number of rows from other
to append to this table.
@param row_indexes Array of row indexes in other
. If NULL
is passed then the
first num_rows
of other
are used.
@param options Bitwise option flags. 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.