diff --git a/README.md b/README.md
index ef432d2..1e40fb0 100644
--- a/README.md
+++ b/README.md
@@ -32,7 +32,7 @@ i7-2600k at 3.4GHz, gcc 4.9, ubuntu 14.10, Single thread.
- No PURE cache benchmark
#### Synthetic data:
- - Generate and test skewed distribution
+ - Generate and test skewed distribution.
*./icbench -a1.5 -m0 -M8 -n100000000*
@@ -119,28 +119,32 @@ i7-2600k at 3.4GHz, gcc 4.9, ubuntu 14.10, Single thread.
## Function usage:
In general compression/decompression functions are of the form:
- *char *endptr = compress( unsigned *in, int n, char *out)*
+ **char *endptr = compress( unsigned *in, int n, [int b,], char *out)**
endptr : set by compress to the next character in "out" after the compressed buffer
in : input integer array
n : number of elements
out : pointer to output buffer
-
- *char *endptr = decompress( char *in, int n, unsigned *out)*
+ b : number of bits. Only for bit packing functions
+
+ **char *endptr = decompress( char *in, int n, [int b,] unsigned *out)**
endptr : set by decompress to the next character in "in" after the decompressed buffer
in : pointer to input buffer
n : number of elements
out : output integer array
+ b : number of bits. Only for bit unpacking functions
-header files with documentation :
- vint.h - variable byte
- vsimple.h - variable simple
- vp4dc.h,vp4dd.h - TurboPFor
- bitpack.h,bitunpack.h - Bit Packing
+header files to use with documentation :
+
| vint.h | Variable byte |
|---|---|
| vsimple.h | Variable simple |
| vp4dc.h, vp4dd.h | TurboPFor |
| bitpack.h bitunpack.h | Bit Packing |