Function tskit::bindings::tsk_tree_get_depth
source · pub unsafe extern "C" fn tsk_tree_get_depth(
self_: *const tsk_tree_t,
u: tsk_id_t,
ret_depth: *mut c_int
) -> c_int
Expand description
@brief Return number of nodes on the path from the specified node to root.
@rst Return the number of nodes on the path from u to root, not including u. The depth of a root is therefore zero.
As a special case, the depth of the
:ref:virtual root <sec_data_model_tree_roots>
is defined as -1.
@endrst
@param self A pointer to a tsk_tree_t object. @param u The tree node. @param ret_depth An int pointer to store the returned node depth. @return 0 on success or a negative value on failure.