Readded description of BPTree

eb8161ac · Philipp Götze · 8b23e7ec · eb8161ac
Commit eb8161ac authored Jan 19, 2021 by Philipp Götze
Hide whitespace changes
Inline Side-by-side

Showing with 8 additions and 0 deletions

src/pbptrees/BPTree.hpp src/pbptrees/BPTree.hpp +8 -0

No files found.
--- a/src/pbptrees/BPTree.hpp
+++ b/src/pbptrees/BPTree.hpp
@@ -35,6 +35,14 @@
 #endif

 namespace dbis::pbptrees {
+/**
+ * An in-memory implementation of a B+ tree.
+ *
+ * @tparam KeyType the data type of the key
+ * @tparam ValueType the data type of the values associated with the key
+ * @tparam N the maximum number of keys on a branch node
+ * @tparam M the maximum number of keys on a leaf node
+ */
 template <typename KeyType, typename ValueType, int N, int M, int NODE_ALIGNMENT = 64>
 class BPTree {
  // we need at least two keys on a branch node to be able to split