summaryrefslogtreecommitdiff
path: root/README.md
blob: af90198e4c80b86ad6173811edd58e70fcfc3e5d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
murmurhash
===========

MurmurHash3 general hash bashed lookup function implementation

## about

[MurmurHash](http://en.wikipedia.org/wiki/MurmurHash) is a non-cryptographic hash function suitable
for general hash-based lookup. This implementation implements version 3
of MurmurHash.

## install

[clib](https://github.com/clibs/clib):

```sh
$ clib install jwerle/murmurhash.c
```

## example

```c

#include <stdlib.h>
#include <string.h>
#include <murmurhash.h>

int
main (void) {
  uint32_t seed = 0;
  const char *key = "kinkajou";
  uint32_t hash = murmurhash(key, (uint32_t) strlen(key), seed); // 0xb6d99cf8
  return 0;
}
```

A command line executable is also available:

```
$ echo -n kinkajou | murmur
3067714808
```

```
$ echo -n panda | murmur --seed=10
1406483717
```

## api

```c
uint32_t
murmurhash (const char *key, uint32_t len, uint32_t seed);
```

Returns a murmur hash of `key` based on `seed` using the MurmurHash3 algorithm.

## license

MIT