experiment plan

coding_benchmark/README.md

@@ -1,11 +1,16 @@
 `coding_benchmark` is the program (by Piotr Beling) for benchmarking implementations of Huffman coding algorithms.
 
-It can test the algorithms included in the following creates:
-- [minimum_redudancy](https://crates.io/crates/minimum_redudancy).
+It can test the implementations included in the following creates:
+- [minimum_redundancy](https://crates.io/crates/minimum_redudancy),
+- [constriction](https://crates.io/crates/constriction),
+- [huffman-compress](https://crates.io/crates/huffman-compress).
 
 Please run the program with the `--help` switch to see the available options.
 
-Below you can find instruction for [installing](#installation) `coding_benchmark`.
+Below you can find instruction for [installing](#installation) `coding_benchmark` and
+[reproducing experiments](#reproducing-experiments-from-the-papers) performed with it,
+which can be found in published or under review papers.
+Note that these instructions have been tested under GNU/Linux and may require some modifications for other systems.
 
 
 # Installation
@@ -19,4 +24,22 @@ Once Rust is installed, just execute the following to install `coding_benchmark`
 
 ```RUSTFLAGS="-C target-cpu=native" cargo install coding_benchmark```
 
-Note that the instruction have been tested under GNU/Linux and may require some modifications for other systems.
+Note that the instruction have been tested under GNU/Linux and may require some modifications for other systems.
+
+
+# Reproducing experiments from the papers
+
+## Rust libraries and programs focused on succinct data structures
+
+To see the results for all implementations, 100MB (100\*1024\*1024=104857600)
+text of randomly drawn (with a non-uniform distribution) 1 byte symbols
+(with an entropy of 4.83 bits/symbol), just execute:
+
+```shell
+./coding_benchmark -t 100 -l 104857600 all
+```
+
+Note that the `-t 100` switch forces a long testing time
+(100s for warming up + about 100s for performing each test).
+It can be omitted to get results faster,
+but averaged over fewer repetitions.