From e2dd0748d61abd09f7138d3790e0d8936a2fb043 Mon Sep 17 00:00:00 2001 From: fc_botelho Date: Tue, 13 Feb 2007 18:03:28 +0000 Subject: [PATCH] documentation of release 0.6 was included --- ALGORITHMS.t2t | 2 +- FOOTER.t2t | 4 ++++ NEWSLOG.t2t | 44 ++++++++++++++++++++++++++++++++++++++++++++ README.t2t | 39 +++++++++++++++------------------------ gendocs | 2 ++ 5 files changed, 66 insertions(+), 25 deletions(-) create mode 100644 NEWSLOG.t2t diff --git a/ALGORITHMS.t2t b/ALGORITHMS.t2t index 4d475ff..5b09b57 100644 --- a/ALGORITHMS.t2t +++ b/ALGORITHMS.t2t @@ -2,5 +2,5 @@ ---------------------------------------- - | [Home index.html] | [CHM chm.html] | [BMZ bmz.html] | [External Memory Based Algorithm brz.html] + | [Home index.html] | [CHM chm.html] | [BMZ bmz.html] | [BRZ Algorithm brz.html] | [FCH Algorithm fch.html] ---------------------------------------- diff --git a/FOOTER.t2t b/FOOTER.t2t index 8e35d2e..a06c47d 100644 --- a/FOOTER.t2t +++ b/FOOTER.t2t @@ -5,4 +5,8 @@ Enjoy! [Davi de Castro Reis davi@users.sourceforge.net] +[Djamel Belazzougui db8192@users.sourceforge.net] + [Fabiano Cupertino Botelho fc_botelho@users.sourceforge.net] + + \ No newline at end of file diff --git a/NEWSLOG.t2t b/NEWSLOG.t2t new file mode 100644 index 0000000..2825dd5 --- /dev/null +++ b/NEWSLOG.t2t @@ -0,0 +1,44 @@ +News Log + + +%!includeconf: CONFIG.t2t + +---------------------------------------- + +==News for version 0.6== + +- [An algorithm to generate MPHFs that require less than 4 bits per key to be stored fch.html], which is referred to as FCH algorithm. The algorithm is only efficient for small sets. +- The FCH algorithm is integrated with [BRZ algorithm brz.html] so that you will be able to efficiently generate space-efficient MPHFs for sets in the order of billion keys. +- All reported bugs and suggestions have been corrected and included as well. + + +---------------------------------------- + +==News for version 0.5== + +- A thread safe vector adapter has been added. +- [A new algorithm for sets in the order of billion of keys that requires approximately 8.1 bits per key to store the resulting MPHFs. brz.html] +- All reported bugs and suggestions have been corrected and included as well. + + +---------------------------------------- + +==News for version 0.4== + +- Vector Adapter has been added. +- An optimized version of bmz (bmz8) for small set of keys (at most 256 keys) has been added. +- All reported bugs and suggestions have been corrected and included as well. + + +---------------------------------------- + +==News for version 0.3== + +- New heuristic added to the bmz algorithm permits to generate a mphf with only + //24.80n + O(1)// bytes. The resulting function can be stored in //3.72n// bytes. +%html% [click here bmz.html#heuristic] for details. + + +%!include: ALGORITHMS.t2t + +%!include: FOOTER.t2t diff --git a/README.t2t b/README.t2t index 3cb81b4..defd85d 100644 --- a/README.t2t +++ b/README.t2t @@ -47,8 +47,8 @@ The CMPH Library encapsulates the newest and more efficient algorithms in an eas A very fast algorithm based on cyclic random graphs to construct minimal perfect hash functions in linear time. The resulting functions are not order preserving and can be stored in only //4cn// bytes, where //c// is between 0.93 and 1.15. -%html% - [External Memory Based Algorithm for sets in the order of billion of keys brz.html] -%txt% - BMZ Algorithm. +%html% - [BRZ Algorithm brz.html]. +%txt% - BRZ Algorithm. A very fast external memory based algorithm for constructing minimal perfect hash functions for sets in the order of billion of keys in linear time. The resulting functions are not order preserving and can be stored using just 8.1 bits per key. @@ -57,37 +57,28 @@ The CMPH Library encapsulates the newest and more efficient algorithms in an eas An algorithm based on acyclic random graphs to construct minimal perfect hash functions in linear time. The resulting functions are order preserving and are stored in //4cn// bytes, where //c// is greater than 2. +%html% - [FCH Algorithm fch.html]. +%txt% - FCH Algorithm. + An algorithm to construct minimal perfect hash functions that require + less than 4 bits per key to be stored. Although the resulting MPHFs are + very compact, the algorithm is only efficient for small sets. + However, it is used as internal algorithm in the BRZ algorithm for efficiently solving + larger problems and even so to generate MPHFs that require approximately + 4.1 bits per key to be stored. For that, you just need to set the parameters -a to brz and + -c to a value larger than or equal to 2.6. -%html% [Click Here comparison.html] to see a comparison of the supported algorithms. +%html% [Click Here comparison.html] to see a comparison between the algorithms BMZ and CHM. ---------------------------------------- -==News for version 0.5== +==News for version 0.6== -- A thread safe vector adapter has been added. -- [A new algorithm for sets in the order of billion of keys that requires approximately 8.1 bits per key to store the resulting MPHFs. brz.html] +- [An algorithm to generate MPHFs that require less than 4 bits per key to be stored fch.html], which is referred to as FCH algorithm. The algorithm is only efficient for small sets. +- The FCH algorithm is integrated with [BRZ algorithm brz.html] so that you will be able to efficiently generate space-efficient MPHFs for sets in the order of billion keys. - All reported bugs and suggestions have been corrected and included as well. ----------------------------------------- - -==News for version 0.4== - -- Vector Adapter has been added. -- An optimized version of bmz (bmz8) for small set of keys (at most 256 keys) has been added. -- All reported bugs and suggestions have been corrected and included as well. - - ----------------------------------------- - -==News for version 0.3== - -- New heuristic added to the bmz algorithm permits to generate a mphf with only - //24.80n + O(1)// bytes. The resulting function can be stored in //3.72n// bytes. -%html% [click here bmz.html#heuristic] for details. - - ---------------------------------------- ==Examples== diff --git a/gendocs b/gendocs index d38c3db..b732b3e 100755 --- a/gendocs +++ b/gendocs @@ -6,6 +6,7 @@ txt2tags -t html -i COMPARISON.t2t -o comparison.html txt2tags -t html -i GPERF.t2t -o gperf.html txt2tags -t html -i FAQ.t2t -o faq.html txt2tags -t html -i CONCEPTS.t2t -o concepts.html +txt2tags -t html -i NEWSLOG.t2t -o newslog.html txt2tags -t txt --mask-email -i README.t2t -o README txt2tags -t txt -i BMZ.t2t -o BMZ @@ -15,3 +16,4 @@ txt2tags -t txt -i COMPARISON.t2t -o COMPARISON txt2tags -t txt -i GPERF.t2t -o GPERF txt2tags -t txt -i FAQ.t2t -o FAQ txt2tags -t txt -i CONCEPTS.t2t -o CONCEPTS +txt2tags -t txt -i NEWSLOG.t2t -o NEWSLOG