doc: readme: explain the benchmark settings

openacid · Jun 28, 2022 · 20b4114 · 20b4114
1 parent b8b8b04
commit 20b4114
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -97,6 +97,22 @@ memory, as a minimized index of huge amount external data.
 
 ![](trie/report/mem_usage.jpg)
 
+The data struct in this benchmark is a slice of key-value pairs with a `SlimTrie` serving as the index.
+The slim itself is built in the **filter** mode, to maximize memory reduction and performance.
+The whole struct `slimKV` is a fully functional kv-store, just like a static `btree`.
+
+```go
+type slimKV struct {
+    slim *trie.SlimTrie
+    Elts []*KVElt
+}
+type KVElt struct {
+    Key string
+    Val int32
+}
+```
+
+You can find the benchmark code in [benchmark](trie/benchmark/benchmark.go);
 
 Read more about [Performance](docs/performance.md)
 

diff --git a/docs/README.md.j2 b/docs/README.md.j2
@@ -87,6 +87,22 @@ memory, as a minimized index of huge amount external data.
 
 ![](trie/report/mem_usage.jpg)
 
+The data struct in this benchmark is a slice of key-value pairs with a `SlimTrie` serving as the index.
+The slim itself is built in the **filter** mode, to maximize memory reduction and performance.
+The whole struct `slimKV` is a fully functional kv-store, just like a static `btree`.
+
+```go
+type slimKV struct {
+    slim *trie.SlimTrie
+    Elts []*KVElt
+}
+type KVElt struct {
+    Key string
+    Val int32
+}
+```
+
+You can find the benchmark code in [benchmark](trie/benchmark/benchmark.go);
 
 Read more about [Performance](docs/performance.md)