obitools/obitools3
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 66 Wiki Activity

Improved AVL tree documentation

Browse Source
This commit is contained in:
Celine Mercier
2016-04-21 15:07:27 +02:00
parent 043e70ff49
commit 2a68cb26f8
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/obiavl.h
View File

@ -377,7 +377,10 @@ index_t obi_avl_find(OBIDMS_avl_p avl, Obi_blob_p value);
* @warning The blob recovered is mapped in memory. * @warning The blob recovered is mapped in memory.
* *
* @param avl_group A pointer to the AVL tree. * @param avl_group A pointer to the AVL tree.
* @param index The index of the value in the data array. * @param index The index of the value in the form of a 64-bit integer
* with the 32 left-most bits coding for the index of the tree of
* the group in which the value is stored, and the 32 right-most bits
* coding for the index at which the value is stored in that AVL tree.
* *
* @returns A pointer to the blob recovered. * @returns A pointer to the blob recovered.
* *
@ -395,7 +398,10 @@ Obi_blob_p obi_avl_group_get(OBIDMS_avl_group_p avl_group, index_t idx);
* @param avl_group A pointer to the AVL tree group. * @param avl_group A pointer to the AVL tree group.
* @param value The blob to add in the AVL tree group. * @param value The blob to add in the AVL tree group.
* *
* @returns The index of the value newly added in the AVL tree group. * @returns The index of the value newly added in the AVL tree group, in the form of a
* 64-bit integer with the 32 left-most bits coding for the index of the tree
* of the group in which the value is stored, and the 32 right-most bits
* coding for the index at which the value is stored in that AVL tree.
* @retval -1 if an error occurred. * @retval -1 if an error occurred.
* *
* @since April 2016 * @since April 2016