Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in / Register
Toggle navigation
F
ffmpeg
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Packages
Packages
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
submodule
ffmpeg
Commits
cd945d21
Commit
cd945d21
authored
Feb 18, 2011
by
Stefano Sabatini
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
lavu/tree: perform minor fixes to av_tree_insert() documentation
parent
6adefeef
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
6 additions
and
2 deletions
+6
-2
tree.h
libavutil/tree.h
+6
-2
No files found.
libavutil/tree.h
View file @
cd945d21
...
@@ -55,18 +55,21 @@ void *av_tree_find(const struct AVTreeNode *root, void *key, int (*cmp)(void *ke
...
@@ -55,18 +55,21 @@ void *av_tree_find(const struct AVTreeNode *root, void *key, int (*cmp)(void *ke
/**
/**
* Insert or remove an element.
* Insert or remove an element.
*
* If *next is NULL, then the supplied element will be removed if it exists.
* If *next is NULL, then the supplied element will be removed if it exists.
* If *next is no
t
NULL, then the supplied element will be inserted, unless
* If *next is no
n-
NULL, then the supplied element will be inserted, unless
* it already exists in the tree.
* it already exists in the tree.
*
* @param rootp A pointer to a pointer to the root node of the tree; note that
* @param rootp A pointer to a pointer to the root node of the tree; note that
* the root node can change during insertions, this is required
* the root node can change during insertions, this is required
* to keep the tree balanced.
* to keep the tree balanced.
* @param key pointer to the element key to insert in the tree
* @param next Used to allocate and free AVTreeNodes. For insertion the user
* @param next Used to allocate and free AVTreeNodes. For insertion the user
* must set it to an allocated and zeroed object of at least
* must set it to an allocated and zeroed object of at least
* av_tree_node_size bytes size. av_tree_insert() will set it to
* av_tree_node_size bytes size. av_tree_insert() will set it to
* NULL if it has been consumed.
* NULL if it has been consumed.
* For deleting elements *next is set to NULL by the user and
* For deleting elements *next is set to NULL by the user and
* av_tree_
node_size
() will set it to the AVTreeNode which was
* av_tree_
insert
() will set it to the AVTreeNode which was
* used for the removed element.
* used for the removed element.
* This allows the use of flat arrays, which have
* This allows the use of flat arrays, which have
* lower overhead compared to many malloced elements.
* lower overhead compared to many malloced elements.
...
@@ -81,6 +84,7 @@ void *av_tree_find(const struct AVTreeNode *root, void *key, int (*cmp)(void *ke
...
@@ -81,6 +84,7 @@ void *av_tree_find(const struct AVTreeNode *root, void *key, int (*cmp)(void *ke
* return av_tree_insert(rootp, key, cmp, next);
* return av_tree_insert(rootp, key, cmp, next);
* }
* }
* @endcode
* @endcode
* @param cmp compare function used to compare elements in the tree
* @return If no insertion happened, the found element; if an insertion or
* @return If no insertion happened, the found element; if an insertion or
* removal happened, then either key or NULL will be returned.
* removal happened, then either key or NULL will be returned.
* 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
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment