Feedback for documentation of C++ open source tool

Hi, we would appreciate any feedback about the documentation of this C++ open source tool:

Entropy estimation tool
Description

This high performance tool outputs on demand of its input:

+ The entropy estimation (through stdout).
+ The minimum, medium and maximum frequencies (through stderr).
+ The frequency of possibilities (through entropy.freq file).
+ The frequency of frequencies (through entropy.gaus file).

These outputs are useful to test the randomness of a source of entropy.
Use
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
#entropy estimation test
entropy 1 input

#standard deviation test
entropy 2 input

#frequency test
entropy 5 input
gnuplot -e "plot 'entropy.freq' with lines" -p

#gaussian distribution test
entropy 7 input
gnuplot -e "plot 'entropy.gaus' with lines" -p

#frequency and gaussian distribution tests
entropy 9 input
gnuplot -e "plot 'entropy.freq' with lines" -p
gnuplot -e "plot 'entropy.gaus' with lines" -p

Install
1
2
#ncomputers.org/debian
apt-get install entropy

Compile

g++ -O3 -std=c++11 entropy.cpp -o entropy

Experimental purposes
1
2
g++ -O3 -std=c++11 entropy.cpp -o entropy-08 -D Bits=8
g++ -O3 -std=c++11 entropy.cpp -o entropy-32 -D Bits=32

http://ncomputers.org/entropy
Last edited on
Topic archived. No new replies allowed.