avutil/tree: improve documentation for av_tree_find, av_tree_insert
[ffmpeg.git] / libavutil / tree.h
1 /*
2  * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 /**
22  * @file
23  * A tree container.
24  * @author Michael Niedermayer <michaelni@gmx.at>
25  */
26
27 #ifndef AVUTIL_TREE_H
28 #define AVUTIL_TREE_H
29
30 #include "attributes.h"
31 #include "version.h"
32
33 /**
34  * @addtogroup lavu_tree AVTree
35  * @ingroup lavu_data
36  *
37  * Low-complexity tree container
38  *
39  * Insertion, removal, finding equal, largest which is smaller than and
40  * smallest which is larger than, all have O(log n) worst-case complexity.
41  * @{
42  */
43
44
45 struct AVTreeNode;
46 extern const int av_tree_node_size;
47
48 /**
49  * Allocate an AVTreeNode.
50  */
51 struct AVTreeNode *av_tree_node_alloc(void);
52
53 /**
54  * Find an element.
55  * @param root a pointer to the root node of the tree
56  * @param next If next is not NULL, then next[0] will contain the previous
57  *             element and next[1] the next element. If either does not exist,
58  *             then the corresponding entry in next is unchanged.
59  * @param cmp compare function used to compare elements in the tree,
60  *            API identical to that of Standard C's qsort
61  * @return An element with cmp(key, elem) == 0 or NULL if no such element
62  *         exists in the tree.
63  */
64 void *av_tree_find(const struct AVTreeNode *root, void *key,
65                    int (*cmp)(void *key, const void *b), void *next[2]);
66
67 /**
68  * Insert or remove an element.
69  *
70  * If *next is NULL, then the supplied element will be removed if it exists.
71  * If *next is non-NULL, then the supplied element will be inserted, unless
72  * it already exists in the tree.
73  *
74  * @param rootp A pointer to a pointer to the root node of the tree; note that
75  *              the root node can change during insertions, this is required
76  *              to keep the tree balanced.
77  * @param key  pointer to the element key to insert in the tree
78  * @param next Used to allocate and free AVTreeNodes. For insertion the user
79  *             must set it to an allocated and zeroed object of at least
80  *             av_tree_node_size bytes size. av_tree_insert() will set it to
81  *             NULL if it has been consumed.
82  *             For deleting elements *next is set to NULL by the user and
83  *             av_tree_insert() will set it to the AVTreeNode which was
84  *             used for the removed element.
85  *             This allows the use of flat arrays, which have
86  *             lower overhead compared to many malloced elements.
87  *             You might want to define a function like:
88  *             @code
89  *             void *tree_insert(struct AVTreeNode **rootp, void *key,
90  *                               int (*cmp)(void *key, const void *b),
91  *                               AVTreeNode **next)
92  *             {
93  *                 if (!*next)
94  *                     *next = av_mallocz(av_tree_node_size);
95  *                 return av_tree_insert(rootp, key, cmp, next);
96  *             }
97  *             void *tree_remove(struct AVTreeNode **rootp, void *key,
98  *                               int (*cmp)(void *key, const void *b, AVTreeNode **next))
99  *             {
100  *                 av_freep(next);
101  *                 return av_tree_insert(rootp, key, cmp, next);
102  *             }
103  *             @endcode
104  * @param cmp compare function used to compare elements in the tree, API identical
105  *            to that of Standard C's qsort
106  * @return If no insertion happened, the found element; if an insertion or
107  *         removal happened, then either key or NULL will be returned.
108  *         Which one it is depends on the tree state and the implementation. You
109  *         should make no assumptions that it's one or the other in the code.
110  */
111 void *av_tree_insert(struct AVTreeNode **rootp, void *key,
112                      int (*cmp)(void *key, const void *b),
113                      struct AVTreeNode **next);
114
115 void av_tree_destroy(struct AVTreeNode *t);
116
117 /**
118  * Apply enu(opaque, &elem) to all the elements in the tree in a given range.
119  *
120  * @param cmp a comparison function that returns < 0 for a element below the
121  *            range, > 0 for a element above the range and == 0 for a
122  *            element inside the range
123  *
124  * @note The cmp function should use the same ordering used to construct the
125  *       tree.
126  */
127 void av_tree_enumerate(struct AVTreeNode *t, void *opaque,
128                        int (*cmp)(void *opaque, void *elem),
129                        int (*enu)(void *opaque, void *elem));
130
131 /**
132  * @}
133  */
134
135 #endif /* AVUTIL_TREE_H */