Skip to content

Commit e9eece6

Browse files
committed
Write readme, document bit limit
1 parent 676018d commit e9eece6

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

v1/README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,14 @@ func GetNum[K comparable](f []byte, valBitSize uint64, key K) uint64
7676

7777
---
7878

79+
## BitLimit
80+
81+
- For fine grained control of bit size of strored values
82+
- Such as: storing integers with only few least significant bits
83+
- Use 0 for byte-aligned automatic control
84+
85+
---
86+
7987
## Supported key/value types
8088

8189
* **Keys**: any `comparable` (int, string, fixed byte arrays, etc.)
@@ -86,7 +94,7 @@ func GetNum[K comparable](f []byte, valBitSize uint64, key K) uint64
8694
8795
---
8896

89-
## Memory efficiency
97+
## Memory efficiency: Ω(⅀values_bits_size)
9098

9199
From benchmarks (`go test --bench=ReadAll`):
92100

0 commit comments

Comments
 (0)