Documentation updated for release 0.9
This commit is contained in:
37
src/main.c
37
src/main.c
@@ -31,9 +31,9 @@ void usage_long(const char *prg)
|
||||
fprintf(stderr, "Minimum perfect hashing tool\n\n");
|
||||
fprintf(stderr, " -h\t print this help message\n");
|
||||
fprintf(stderr, " -c\t c value determines:\n");
|
||||
fprintf(stderr, " \t the number of vertices in the graph for the algorithms BMZ and CHM\n");
|
||||
fprintf(stderr, " \t the number of bits per key required in the FCH algorithm\n");
|
||||
fprintf(stderr, " \t the load factor in the CHD_PH algorithm\n");
|
||||
fprintf(stderr, " \t * the number of vertices in the graph for the algorithms BMZ and CHM\n");
|
||||
fprintf(stderr, " \t * the number of bits per key required in the FCH algorithm\n");
|
||||
fprintf(stderr, " \t * the load factor in the CHD_PH algorithm\n");
|
||||
fprintf(stderr, " -a\t algorithm - valid values are\n");
|
||||
for (i = 0; i < CMPH_COUNT; ++i) fprintf(stderr, " \t * %s\n", cmph_names[i]);
|
||||
fprintf(stderr, " -f\t hash function (may be used multiple times) - valid values are\n");
|
||||
@@ -44,20 +44,23 @@ void usage_long(const char *prg)
|
||||
fprintf(stderr, " -g\t generation mode\n");
|
||||
fprintf(stderr, " -s\t random seed\n");
|
||||
fprintf(stderr, " -m\t minimum perfect hash function file \n");
|
||||
fprintf(stderr, " -M\t main memory availability (in MB)\n");
|
||||
fprintf(stderr, " -d\t temporary directory used in brz algorithm \n");
|
||||
fprintf(stderr, " -b\t the meaning of this parameter depends on the algorithm used.\n");
|
||||
fprintf(stderr, " \t If BRZ algorithm is selected in -a option, than it is used\n");
|
||||
fprintf(stderr, " \t to make the maximal number of keys in a bucket lower than 256.\n");
|
||||
fprintf(stderr, " \t In this case its value should be an integer in the range [64,175].\n");
|
||||
fprintf(stderr, " \t If BDZ algorithm is selected in option -a, than it is used to\n");
|
||||
fprintf(stderr, " \t determine the size of some precomputed rank information and\n");
|
||||
fprintf(stderr, " \t its value should be an integer in the range [3,10].\n");
|
||||
fprintf(stderr, " \t If CHD_PH algorithm is selected in option -a, than it is used to\n");
|
||||
fprintf(stderr, " \t set average number of keys per bucket and its value should be an\n");
|
||||
fprintf(stderr, " \t an integer in the range [1,32].\n");
|
||||
fprintf(stderr, " -t\t set the number of keys per bin for a t-perfect hashing function.\n");
|
||||
fprintf(stderr, " \t A t-perfect hashing function allows at most t collisions in a given bin.\n");
|
||||
fprintf(stderr, " -M\t main memory availability (in MB) used in BRZ algorithm \n");
|
||||
fprintf(stderr, " -d\t temporary directory used in BRZ algorithm \n");
|
||||
fprintf(stderr, " -b\t the meaning of this parameter depends on the algorithm selected in the -a option:\n");
|
||||
fprintf(stderr, " \t * For BRZ it is used to make the maximal number of keys in a bucket lower than 256.\n");
|
||||
fprintf(stderr, " \t In this case its value should be an integer in the range [64,175]. Default is 128.\n\n");
|
||||
fprintf(stderr, " \t * For BDZ it is used to determine the size of some precomputed rank\n");
|
||||
fprintf(stderr, " \t information and its value should be an integer in the range [3,10]. Default\n");
|
||||
fprintf(stderr, " \t is 7. The larger is this value, the more compact are the resulting functions\n");
|
||||
fprintf(stderr, " \t and the slower are them at evaluation time.\n\n");
|
||||
fprintf(stderr, " \t * For CHD and CHD_PH it is used to set the average number of keys per bucket\n");
|
||||
fprintf(stderr, " \t and its value should be an integer in the range [1,32]. Default is 4. The\n");
|
||||
fprintf(stderr, " \t larger is this value, the slower is the construction of the functions.\n");
|
||||
fprintf(stderr, " \t This parameter has no effect for other algorithms.\n\n");
|
||||
fprintf(stderr, " -t\t set the number of keys per bin for a t-perfect hashing function. A t-perfect\n");
|
||||
fprintf(stderr, " \t hash function allows at most t collisions in a given bin. This parameter applies\n");
|
||||
fprintf(stderr, " \t only to the CHD and CHD_PH algorithms. Its value should be an integer in the\n");
|
||||
fprintf(stderr, " \t range [1,128]. Defaul is 1\n");
|
||||
fprintf(stderr, " keysfile\t line separated file with keys\n");
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user