@@ -30,37 +30,37 @@ To build the code, [`CMake`](https://cmake.org/) is required.
30
30
31
31
Clone the repository with
32
32
33
- $ git clone --recursive https://github.com/jermp/interpolative_coding.git
33
+ git clone --recursive https://github.com/jermp/interpolative_coding.git
34
34
35
35
If you have cloned the repository without ` --recursive ` , you will need to perform the following commands before
36
36
compiling:
37
37
38
- $ git submodule init
39
- $ git submodule update
38
+ git submodule init
39
+ git submodule update
40
40
41
41
To compile the code for a release environment * and* best performance (see file ` CMakeLists.txt ` for the used compilation flags), do:
42
42
43
- $ mkdir build
44
- $ cd build
45
- $ cmake .. -DRUNAWARE=On
46
- $ make
43
+ mkdir build
44
+ cd build
45
+ cmake .. -DRUNAWARE=On
46
+ make
47
47
48
48
Hint: Use ` make -j4 ` to compile the library in parallel using, e.g., 4 jobs.
49
49
50
50
For a testing environment, use the following instead:
51
51
52
- $ mkdir debug_build
53
- $ cd debug_build
54
- $ cmake .. -DCMAKE_BUILD_TYPE=Debug -DUSE_SANITIZERS=On
55
- $ make
52
+ mkdir debug_build
53
+ cd debug_build
54
+ cmake .. -DCMAKE_BUILD_TYPE=Debug -DUSE_SANITIZERS=On
55
+ make
56
56
57
57
Quick Start
58
58
-------
59
59
60
60
For a quick start, see the source file ` test/example.cpp ` .
61
61
After compilation, run this example with
62
62
63
- $ ./example
63
+ ./example
64
64
65
65
A simpler variation is shown below.
66
66
@@ -146,15 +146,15 @@ such organization.
146
146
147
147
To encode all the sequences from this file, do:
148
148
149
- $ ./encode leftmost_minimal ../data/test_collection.docs -o test.bin
149
+ ./encode leftmost_minimal ../data/test_collection.docs -o test.bin
150
150
151
151
To decode all the sequences from the encoded file `test.bin`, do:
152
152
153
- $ ./decode leftmost_minimal test.bin
153
+ ./decode leftmost_minimal test.bin
154
154
155
155
To check correctness of the implementation, use:
156
156
157
- $ ./check leftmost_minimal .. /data/test_collection.docs test.bin
157
+ ./check leftmost_minimal test.bin .. /data/test_collection.docs
158
158
159
159
which will compare every decoded integer against the input collection.
160
160
0 commit comments