Function tskit::bindings::tsk_tree_get_branch_length
source · pub unsafe extern "C" fn tsk_tree_get_branch_length(
self_: *const tsk_tree_t,
u: tsk_id_t,
ret_branch_length: *mut f64
) -> c_int
Expand description
@brief Return the length of the branch ancestral to the specified node.
@rst Return the length of the branch ancestral to the specified node. Branch length is defined as difference between the time of a node and its parent. The branch length of a root is zero. @endrst
@param self A pointer to a tsk_tree_t object. @param u The tree node. @param ret_branch_length A double pointer to store the returned branch length. @return 0 on success or a negative value on failure.