CMPH - C Minimal Perfect Hashing Library


Motivation

A perfect hash function maps a static set of n keys into a set of m integer numbers without collisions, where m is greater than or equal to n. If m is equal to n, the function is called minimal.

Minimal perfect hash functions are widely used for memory efficient storage and fast retrieval of items from static sets, such as words in natural languages, reserved words in programming languages or interactive systems, universal resource locations (URLs) in Web search engines, or item sets in data mining techniques. Therefore, there are applications for minimal perfect hash functions in information retrieval systems, database systems, language translation systems, electronic commerce systems, compilers, operating systems, among others.

The use of minimal perfect hash functions is, until now, restricted to scenarios where the set of keys being hashed is small, because of the limitations of current algorithms. But in many cases, to deal with huge set of keys is crucial. So, this project gives to the free software community an API that will work with sets in the order of billion of keys.

Probably, the most interesting application for minimal perfect hash functions is its use as an indexing structure for databases. The most popular data structure used as an indexing structure in databases is the B+ tree. In fact, the B+ tree is very used for dynamic applications with frequent insertions and deletions of records. However, for applications with sporadic modifications and a huge number of queries the B+ tree is not the best option, because practical deployments of this structure are extremely complex, and perform poorly with very large sets of keys such as those required for the new frontiers database applications.

For example, in the information retrieval field, the work with huge collections is a daily task. The simple assignment of ids to web pages of a collection can be a challenging task. While traditional databases simply cannot handle more traffic once the working set of web page urls does not fit in main memory anymore, minimal perfect hash functions can easily scale to hundred of millions of entries, using stock hardware.

As there are lots of applications for minimal perfect hash functions, it is important to implement memory and time efficient algorithms for constructing such functions. The lack of similar libraries in the free software world has been the main motivation to create the C Minimal Perfect Hashing Library (gperf is a bit different, since it was conceived to create very fast perfect hash functions for small sets of keys and CMPH Library was conceived to create minimal perfect hash functions for very large sets of keys). C Minimal Perfect Hashing Library is a portable LGPLed library to generate and to work with very efficient minimal perfect hash functions.


Description

The CMPH Library encapsulates the newest and more efficient algorithms in an easy-to-use, production-quality, fast API. The library was designed to work with big entries that cannot fit in the main memory. It has been used successfully for constructing minimal perfect hash functions for sets with more than 100 million of keys, and we intend to expand this number to the order of billion of keys. Although there is a lack of similar libraries, we can point out some of the distinguishable features of the CMPH Library:


Supported Algorithms


News for version 2.0

Cleaned up most warnings for the c code.

Experimental C++ interface (--enable-cxxmph) implementing the BDZ algorithm in a convenient interface, which serves as the basis for drop-in replacements for std::unordered_map, sparsehash::sparse_hash_map and sparsehash::dense_hash_map. Potentially faster lookup time at the expense of insertion time. See cxxmpph/mph_map.h and cxxmph/mph_index.h for details.

News for version 1.1

Fixed a bug in the chd_pc algorithm and reorganized tests.

News for version 1.0

This is a bugfix only version, after which a revamp of the cmph code and algorithms will be done.

News for version 0.9

News for version 0.8

News log


Examples

Using cmph is quite simple. Take a look.

  #include <cmph.h>
  #include <string.h>
  // Create minimal perfect hash function from in-memory vector
  int main(int argc, char **argv)
  { 
  
      // Creating a filled vector
      unsigned int i = 0;
      const char *vector[] = {"aaaaaaaaaa", "bbbbbbbbbb", "cccccccccc", "dddddddddd", "eeeeeeeeee", 
          "ffffffffff", "gggggggggg", "hhhhhhhhhh", "iiiiiiiiii", "jjjjjjjjjj"};
      unsigned int nkeys = 10;
      FILE* mphf_fd = fopen("temp.mph", "w");
      // Source of keys
      cmph_io_adapter_t *source = cmph_io_vector_adapter((char **)vector, nkeys);
  
      //Create minimal perfect hash function using the brz algorithm.
      cmph_config_t *config = cmph_config_new(source);
      cmph_config_set_algo(config, CMPH_BRZ);
      cmph_config_set_mphf_fd(config, mphf_fd);
      cmph_t *hash = cmph_new(config);
      cmph_config_destroy(config);
      cmph_dump(hash, mphf_fd); 
      cmph_destroy(hash);	
      fclose(mphf_fd);
  
      //Find key
      mphf_fd = fopen("temp.mph", "r");
      hash = cmph_load(mphf_fd);
      while (i < nkeys) {
          const char *key = vector[i];
          unsigned int id = cmph_search(hash, key, (cmph_uint32)strlen(key));
          fprintf(stderr, "key:%s -- hash:%u\n", key, id);
          i++;
      }
  
      //Destroy hash
      cmph_destroy(hash);
      cmph_io_vector_adapter_destroy(source);   
      fclose(mphf_fd);
      return 0;
  }

Download vector_adapter_ex1.c. This example does not work in versions below 0.6. You need to update the sources from GIT to make it work.


  #include <cmph.h>
  #include <stdio.h>
  #include <string.h>
   // Create minimal perfect hash function from in-disk keys using BDZ algorithm
  int main(int argc, char **argv)
  {   
  	 //Open file with newline separated list of keys
  	FILE * keys_fd = fopen("keys.txt", "r");
  	cmph_t *hash = NULL;
  	if (keys_fd == NULL) 
  	{
  	  fprintf(stderr, "File \"keys.txt\" not found\n");
  	  exit(1);
  	}	
  	// Source of keys
  	cmph_io_adapter_t *source = cmph_io_nlfile_adapter(keys_fd);
  
  	cmph_config_t *config = cmph_config_new(source);
  	cmph_config_set_algo(config, CMPH_BDZ);
  	hash = cmph_new(config);
  	cmph_config_destroy(config);
     
  	//Find key
  	const char *key = "jjjjjjjjjj";
  	unsigned int id = cmph_search(hash, key, (cmph_uint32)strlen(key));
  	fprintf(stderr, "Id:%u\n", id);
  	//Destroy hash
  	cmph_destroy(hash);
  	cmph_io_nlfile_adapter_destroy(source);   
  	fclose(keys_fd);
  	return 0;
  }

Download file_adapter_ex2.c and keys.txt. This example does not work in versions below 0.8. You need to update the sources from GIT to make it work.

Click here to see more examples


The cmph application

cmph is the name of both the library and the utility application that comes with this package. You can use the cmph application for constructing minimal perfect hash functions from the command line. The cmph utility comes with a number of flags, but it is very simple to create and to query minimal perfect hash functions:

   $ # Using the chm algorithm (default one) for constructing a mphf for keys in file keys_file
   $ ./cmph -g keys_file
   $ # Query id of keys in the file keys_query
   $ ./cmph -m keys_file.mph keys_query

The additional options let you set most of the parameters you have available through the C API. Below you can see the full help message for the utility.

  usage: cmph [-v] [-h] [-V] [-k nkeys] [-f hash_function] [-g [-c algorithm_dependent_value][-s seed] ] 
              [-a algorithm] [-M memory_in_MB] [-b algorithm_dependent_value] [-t keys_per_bin] [-d tmp_dir] 
              [-m file.mph] keysfile
  Minimum perfect hashing tool
  
    -h	 print this help message
    -c	 c value determines:
      	  * the number of vertices in the graph for the algorithms BMZ and CHM
      	  * the number of bits per key required in the FCH algorithm
      	  * the load factor in the CHD_PH algorithm
    -a	 algorithm - valid values are
      	  * bmz
      	  * bmz8
      	  * chm
      	  * brz
      	  * fch
      	  * bdz
      	  * bdz_ph
      	  * chd_ph
      	  * chd
    -f	 hash function (may be used multiple times) - valid values are
      	  * jenkins
    -V	 print version number and exit
    -v	 increase verbosity (may be used multiple times)
    -k	 number of keys
    -g	 generation mode
    -s	 random seed
    -m	 minimum perfect hash function file 
    -M	 main memory availability (in MB) used in BRZ algorithm 
    -d	 temporary directory used in BRZ algorithm 
    -b	 the meaning of this parameter depends on the algorithm selected in the -a option:
      	  * For BRZ it is used to make the maximal number of keys in a bucket lower than 256.
      	    In this case its value should be an integer in the range [64,175]. Default is 128.
  
      	  * For BDZ it is used to determine the size of some precomputed rank
      	    information and its value should be an integer in the range [3,10]. Default
      	    is 7. The larger is this value, the more compact are the resulting functions
      	    and the slower are them at evaluation time.
  
      	  * For CHD and CHD_PH it is used to set the average number of keys per bucket
      	    and its value should be an integer in the range [1,32]. Default is 4. The
      	    larger is this value, the slower is the construction of the functions.
      	    This parameter has no effect for other algorithms.
  
    -t	 set the number of keys per bin for a t-perfect hashing function. A t-perfect
      	 hash function allows at most t collisions in a given bin. This parameter applies
      	 only to the CHD and CHD_PH algorithms. Its value should be an integer in the
      	 range [1,128]. Defaul is 1
    keysfile	 line separated file with keys

Additional Documentation

FAQ

Downloads

Use the project page at sourceforge: http://sf.net/projects/cmph

License Stuff

Code is under the LGPL and the MPL 1.1.


Enjoy!

Davi de Castro Reis

Djamel Belazzougui

Fabiano Cupertino Botelho

Nivio Ziviani

SourceForge.net Logo

Last Updated: Sat Jun 9 04:07:31 2012