Function tskit::bindings::tsk_variant_decode
source · pub unsafe extern "C" fn tsk_variant_decode(
self_: *mut tsk_variant_t,
site_id: tsk_id_t,
options: tsk_flags_t
) -> c_int
Expand description
@brief Decode the genotypes at the given site, storing them in this variant.
@rst
Decodes the genotypes for this variant’s samples, indexed to this variant’s alleles,
at the specified site.
This method is most efficient at decoding sites in-order, either forwards or backwards
along the tree sequence. Resulting genotypes are stored in the genotypes
member of
this variant.
@endrst
@param self A pointer to an initialised tsk_variant_t object.
@param site_id A valid site id for the tree sequence of this variant.
@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.