Function tskit::bindings::tsk_tree_get_parent
source · pub unsafe extern "C" fn tsk_tree_get_parent(
self_: *const tsk_tree_t,
u: tsk_id_t,
parent: *mut tsk_id_t
) -> c_int
Expand description
@brief Returns the parent of the specified node.
@rst
Equivalent to tree.parent[u]
with bounds checking for the node u.
Performance sensitive code which can guarantee that the node u is
valid should use the direct array access in preference to this method.
@endrst
@param self A pointer to a tsk_tree_t object. @param u The tree node. @param parent A tsk_id_t pointer to store the returned parent node. @return 0 on success or a negative value on failure.