Function tskit::bindings::tsk_tree_get_left_root

source · 
pub unsafe extern "C" fn tsk_tree_get_left_root(
    self_: *const tsk_tree_t
) -> tsk_id_t
Expand description

@brief Returns the leftmost 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.left_child[tree.virtual_root]. @endrst

@param self A pointer to an initialised tsk_tree_t object. @return Returns the leftmost root in the tree.