aboutsummaryrefslogtreecommitdiff
path: root/common/sp_tree.c
diff options
context:
space:
mode:
authorKimplul <kimi.h.kuparinen@gmail.com>2022-05-22 23:35:02 +0300
committerKimplul <kimi.h.kuparinen@gmail.com>2022-05-22 23:35:02 +0300
commit72df0de8cb579fd96449d19eb57fc71335907a19 (patch)
tree6a0a24478fe95f009619787afd24ddfe5df8cfd7 /common/sp_tree.c
parentd99be9e2912e0726ab779053b43a89e3b9e21490 (diff)
downloadkmi-72df0de8cb579fd96449d19eb57fc71335907a19.tar.gz
kmi-72df0de8cb579fd96449d19eb57fc71335907a19.zip
add @file info to all files
+ Next step, start documenting contents of each file.
Diffstat (limited to 'common/sp_tree.c')
-rw-r--r--common/sp_tree.c10
1 files changed, 10 insertions, 0 deletions
diff --git a/common/sp_tree.c b/common/sp_tree.c
index 5097757..9003f40 100644
--- a/common/sp_tree.c
+++ b/common/sp_tree.c
@@ -1,3 +1,13 @@
+/**
+ * @file sp_tree.c
+ * Implementation of my sp_trees. An sp_tree is a mix of rb-trees and avl-trees,
+ * with slightly faster insertion but worse tree depth on average.
+ *
+ * See https://github.com/Kimplul/sptree
+ *
+ * \todo Document sp_tree algorithm better.
+ */
+
#include <apos/sp_tree.h>
static void __sp_turn_left(struct sp_node *n)