rust/tantivy
1
0
Fork 0
mirror of https://github.com/quickwit-oss/tantivy.git synced 2026-06-03 17:10:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

update fast field codec readme

Browse Source
This commit is contained in:
PSeitz
2021-06-15 09:19:39 +02:00
committed by GitHub
parent f902440b8b
commit 268e6bfe6e
1 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
fastfield_codecs/README.md
View File

@@ -10,8 +10,10 @@ Contributing is pretty straightforward. Since the bitpacking is the simplest com
A codec needs to implement 2 traits:
A reader implementing `FastFieldCodecReader` to read the codec.
A serializer implementing `FastFieldCodecSerializer` for compression estimation and codec name + id.
- A reader implementing `FastFieldCodecReader` to read the codec.
- A serializer implementing `FastFieldCodecSerializer` for compression estimation and codec name + id.
### Tests
Once the traits are implemented test and benchmark integration is pretty easy (see `test_with_codec_data_sets` and `bench.rs`).
@@ -20,8 +22,12 @@ Make sure to add the codec to the main.rs, which tests the compression ratio and
cargo run --features bin
```
### TODO
- Add real world data sets in comparison
- Add codec to cover sparse data sets
Example Result
### Codec Comparison
```
+----------------------------------+-------------------+------------------------+
| | Compression Ratio | Compression Estimation |