The perfect-hash-generator package

[ Tags: apache, data-structures, embedded, library, program ] [ Propose Tags ]

A perfect hash function for a set S is a hash function that maps distinct elements in S to a set of integers, with no collisions. A minimal perfect hash function is a perfect hash function that maps n keys to n consecutive integers, e.g. the numbers from 0 to n-1.

In contrast with the PerfectHash package, which is a binding to a C-based library, this package is a fully-native Haskell implementation.

It is intended primarily for generating C code for embedded applications (compare to gperf). The output of this tool is a pair of arrays that can be included in generated C code for allocation-free hash tables.

Though lookups also perform reasonably well for Haskell applications, it hasn't been benchmarked thorougly with respect to other data structures.

This implementation was adapted from Steve Hanov's Blog.

Usage

The library is written generically to hash both strings and raw integers. Integers should be wrapped in the Atom newtype:

import Data.PerfectHash.Construction (createMinimalPerfectHash)

tuples = [
   (Atom 1000, 1)
 , (Atom 5555, 2)
 , (Atom 9876, 3)
 ]

lookup_table = createMinimalPerfectHash tuples

Generation of C code based on the arrays in lookup_table is left as an exercise to the reader. Algorithm documentation in the Data.PerfectHash.Hashing and Data.PerfectHash.Lookup modules will be helpful.

See the hash-perfectly-strings-demo and hash-perfectly-ints-demo, as well as the test suite, for working examples.

$ stack build
$ stack exec hash-perfectly-strings-demo

Caveats

Only integer keys of at most 32-bits have been demonstrated to work properly. Since the hash function masks to 32 bits, colliding 64-bit integers can hang the lookup table construction.

Properties

Versions 0.1.0.0, 0.1.0.1, 0.1.0.2, 0.1.0.3, 0.1.0.4 (info)
Dependencies base (>=4.5 && <=4.10), containers, data-ordlist, directory, filepath, hashable, optparse-applicative, perfect-hash-generator, random, unordered-containers, vector [details]
License Apache-2.0
Author Karl Ostmo <kostmo@gmail.com>
Maintainer Karl Ostmo <kostmo@gmail.com>
Category Data Structures, Embedded
Home page https://github.com/kostmo/perfect-hash-generator#readme
Bug tracker https://github.com/kostmo/perfect-hash-generator/issues
Source repository head: git clone https://github.com/kostmo/perfect-hash-generator
Uploaded Mon Nov 6 08:39:51 UTC 2017 by kostmo
Distributions NixOS:0.1.0.4
Executables hash-perfectly-strings-demo, hash-perfectly-ints-demo
Downloads 123 total (123 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2017-11-06 [all 1 reports]
Hackage Matrix CI

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees