-
Notifications
You must be signed in to change notification settings - Fork 74
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add README for locustdb-compression-utils
- Loading branch information
Showing
1 changed file
with
17 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# LocustDB Compression Utils | ||
|
||
Collection of utils for compressing a series of values. | ||
|
||
## XOR float compression | ||
|
||
One of compression algorithms implemented is a variant of the XOR float compression algorithm described in [Gorilla: A Fast, Scalable, In-Memory Time Series Database](https://www.vldb.org/pvldb/vol8/p1816-teller.pdf). The "gorilla_time" example program creates visualizations of the compression algorithm. You can run the visualization with: | ||
|
||
```bash | ||
cargo run --example gorilla_time -- --verbose | ||
``` | ||
|
||
Run the following command to see more options: | ||
|
||
```bash | ||
cargo run --example gorilla_time -- --help | ||
``` |