Commit bc47d126 authored by Michael Niedermayer's avatar Michael Niedermayer

Merge commit 'a9b04b2c'

* commit 'a9b04b2c':
  tree.h: K&R formatting and typo cosmetics
Merged-by: 's avatarMichael Niedermayer <michaelni@gmx.at>
parents 11ace706 a9b04b2c
...@@ -34,10 +34,10 @@ ...@@ -34,10 +34,10 @@
* @addtogroup lavu_tree AVTree * @addtogroup lavu_tree AVTree
* @ingroup lavu_data * @ingroup lavu_data
* *
* Low complexity tree container * Low-complexity tree container
* *
* Insertion, removal, finding equal, largest which is smaller than and * Insertion, removal, finding equal, largest which is smaller than and
* smallest which is larger than, all have O(log n) worst case complexity. * smallest which is larger than, all have O(log n) worst-case complexity.
* @{ * @{
*/ */
...@@ -56,10 +56,11 @@ struct AVTreeNode *av_tree_node_alloc(void); ...@@ -56,10 +56,11 @@ struct AVTreeNode *av_tree_node_alloc(void);
* @param next If next is not NULL, then next[0] will contain the previous * @param next If next is not NULL, then next[0] will contain the previous
* element and next[1] the next element. If either does not exist, * element and next[1] the next element. If either does not exist,
* then the corresponding entry in next is unchanged. * then the corresponding entry in next is unchanged.
* @return An element with cmp(key, elem)==0 or NULL if no such element exists in * @return An element with cmp(key, elem) == 0 or NULL if no such element
* the tree. * exists in the tree.
*/ */
void *av_tree_find(const struct AVTreeNode *root, void *key, int (*cmp)(void *key, const void *b), void *next[2]); void *av_tree_find(const struct AVTreeNode *root, void *key,
int (*cmp)(void *key, const void *b), void *next[2]);
/** /**
* Insert or remove an element. * Insert or remove an element.
...@@ -83,11 +84,17 @@ void *av_tree_find(const struct AVTreeNode *root, void *key, int (*cmp)(void *ke ...@@ -83,11 +84,17 @@ void *av_tree_find(const struct AVTreeNode *root, void *key, int (*cmp)(void *ke
* lower overhead compared to many malloced elements. * lower overhead compared to many malloced elements.
* You might want to define a function like: * You might want to define a function like:
* @code * @code
* void *tree_insert(struct AVTreeNode **rootp, void *key, int (*cmp)(void *key, const void *b), AVTreeNode **next){ * void *tree_insert(struct AVTreeNode **rootp, void *key,
* if(!*next) *next= av_mallocz(av_tree_node_size); * int (*cmp)(void *key, const void *b),
* AVTreeNode **next)
* {
* if (!*next)
* *next = av_mallocz(av_tree_node_size);
* return av_tree_insert(rootp, key, cmp, next); * return av_tree_insert(rootp, key, cmp, next);
* } * }
* void *tree_remove(struct AVTreeNode **rootp, void *key, int (*cmp)(void *key, const void *b, AVTreeNode **next)){ * void *tree_remove(struct AVTreeNode **rootp, void *key,
* int (*cmp)(void *key, const void *b, AVTreeNode **next))
* {
* av_freep(next); * av_freep(next);
* return av_tree_insert(rootp, key, cmp, next); * return av_tree_insert(rootp, key, cmp, next);
* } * }
...@@ -98,7 +105,10 @@ void *av_tree_find(const struct AVTreeNode *root, void *key, int (*cmp)(void *ke ...@@ -98,7 +105,10 @@ void *av_tree_find(const struct AVTreeNode *root, void *key, int (*cmp)(void *ke
* Which one it is depends on the tree state and the implementation. You * Which one it is depends on the tree state and the implementation. You
* should make no assumptions that it's one or the other in the code. * should make no assumptions that it's one or the other in the code.
*/ */
void *av_tree_insert(struct AVTreeNode **rootp, void *key, int (*cmp)(void *key, const void *b), struct AVTreeNode **next); void *av_tree_insert(struct AVTreeNode **rootp, void *key,
int (*cmp)(void *key, const void *b),
struct AVTreeNode **next);
void av_tree_destroy(struct AVTreeNode *t); void av_tree_destroy(struct AVTreeNode *t);
/** /**
...@@ -111,7 +121,9 @@ void av_tree_destroy(struct AVTreeNode *t); ...@@ -111,7 +121,9 @@ void av_tree_destroy(struct AVTreeNode *t);
* @note The cmp function should use the same ordering used to construct the * @note The cmp function should use the same ordering used to construct the
* tree. * tree.
*/ */
void av_tree_enumerate(struct AVTreeNode *t, void *opaque, int (*cmp)(void *opaque, void *elem), int (*enu)(void *opaque, void *elem)); void av_tree_enumerate(struct AVTreeNode *t, void *opaque,
int (*cmp)(void *opaque, void *elem),
int (*enu)(void *opaque, void *elem));
/** /**
* @} * @}
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment