Function tskit::bindings::tsk_tree_get_right_root
source · pub unsafe extern "C" fn tsk_tree_get_right_root(
self_: *const tsk_tree_t
) -> tsk_id_t
Expand description
@brief Returns the rightmost root in this tree.
@rst
See the :ref:sec_data_model_tree_roots
section for more information
on how the roots of a tree are defined.
This function is equivalent to tree.right_child[tree.virtual_root]
.
@endrst
@param self A pointer to an initialised tsk_tree_t object. @return Returns the rightmost root in the tree.