# mur3
Rust implementation of MurmurHash3.

[![Crates.io](https://img.shields.io/crates/v/mur3.svg?maxAge=2592000)](https://crates.io/crates/mur3)
[![docs.rs](https://docs.rs/mur3/badge.svg)](https://docs.rs/mur3)
[![Build Status](https://github.com/tikv/mur3/workflows/CI/badge.svg)](https://github.com/tikv/mur3/actions)

### TODO

- [x] Add benchmakr results
- [x] Write usage docs
- [x] Add correctness check comparing to C implements
- [ ] Add x86_128 implement

### Benchmark

#### murmurhash3_x86_32

 input size|  Function (ns,MiB/s) | Hasher | C implementation
-----------|------------|--------|----------
 0         |  3.8183<br/>0  | 17.595<br/>0 | 11.444<br/>0
 1         | 5.2481<br/>181.72 | 23.207<br/>41.094 | 12.257<br/>77.806
 2         | 4.7781<br/>399.19 | 24.801<br/>76.906 | 12.897<br/>147.90
 3         | 5.3299<br/>536.79 | 24.981<br/>114.53 | 12.717<br/>224.98
 4         | 5.1213<br/>744.87 | 17.726<br/>215.21 | 12.774<br/>298.64
 32        | 16.253<br/>1833.6 | 22.755<br/>1309.7 | 21.472<br/>1387.9
 64        | 29.913<br/>1992.6 | 35.920<br/>1659.4 | 36.617<br/>1627.8
 128       | 59.530<br/>2002.5 | 64.599<br/>1845.4 | 67.039<br/>1778.2
 256       | 123.25<br/>1934.5 | 126.34<br/>1887.2 | 139.03<br/>1714.9
 1024      | 483.38<br/>1972.9 | 482.87<br/>1975.0 | 537.98<br/>1772.7
 4096      | 1927.8<br/>1978.7 | 1903.6<br/>2004.0 | 2153.9<br/>1771.1
 8192      | 3850.0<br/>1981.7 | 3853.0<br/>1980.1 | 4340.2<br/>1757.8

#### murmurhash3_x64_128

 input size|  Function (ns,MiB/s) | Hasher | C implementation
-----------|------------|--------|----------
 0         |  8.0913<br/>0  | 12.850<br/>0 | 9.2690<br/>0
 1         | 11.506<br/>82.882 | 25.815<br/>36.942 | 11.572<br/>82.415
 2         | 12.685<br/>150.37 | 26.467<br/>72.064 | 11.967<br/>159.39
 3         | 14.075<br/>203.27 | 26.976<br/>106.06 | 12.198<br/>234.54
 4         | 9.5975<br/>397.47 | 14.618<br/>260.96 | 12.689<br/>300.64
 7         | 14.098<br/>473.52 | 20.176<br/>330.88 | 13.845<br/>482.16
 13        | 11.870<br/>1020.0 | 18.302<br/>677.39 | 16.878<br/>734.53
 16        | 11.195<br/>1331.1 | 14.872<br/>1002.0 | 12.821<br/>1162.3
 32        | 14.040<br/>2122.7 | 17.883<br/>1666.6 | 15.739<br/>1893.5
 64        | 23.104<br/>2579.9 | 25.727<br/>2316.9 | 22.327<br/>2669.7
 128       | 34.333<br/>3472.2 | 40.924<br/>2913.0 | 35.334<br/>3373.8
 256       | 62.698<br/>3802.6 | 68.656<br/>3472.7 | 62.235<br/>3830.9
 1024      | 239.06<br/>3989.3 | 252.23<br/>3781.0 | 225.46<br/>4229.9
 4096      | 900.40<br/>4236.7 | 995.50<br/>3831.9 | 884.38<br/>4313.4
 8192      | 1800.1<br/>4238.3 | 2000.1<br/>3814.4 | 1753.8<br/>4350.1