#hash #fxhash

no-std zwohash

A fast, deterministic, non-cryptographic hash for use in hash tables

3 releases

0.1.2 Sep 4, 2020
0.1.1 Aug 30, 2020
0.1.0 Aug 17, 2020

#630 in Algorithms

Download history 38099/week @ 2023-11-03 28713/week @ 2023-11-10 46084/week @ 2023-11-17 14601/week @ 2023-11-24 21718/week @ 2023-12-01 20117/week @ 2023-12-08 17220/week @ 2023-12-15 13706/week @ 2023-12-22 17259/week @ 2023-12-29 36624/week @ 2024-01-05 47861/week @ 2024-01-12 26403/week @ 2024-01-19 38313/week @ 2024-01-26 30653/week @ 2024-02-02 29662/week @ 2024-02-09 32572/week @ 2024-02-16

135,203 downloads per month
Used in 3 crates

0BSD license

22KB
232 lines

ZwoHash

ci github crates.io docs.rs

ZwoHash implements a very fast hash algorithm optimized for the use in hash tables. It has low per-hash overhead, which is important when hashing small keys. It is non-cryptographic and deterministic and as such not suited for inserting untrusted user-provided input into hash tables, unless other denial of service countermeasures are taken. As such it covers the same use cases as rustc's FxHash.

Compared to FxHash, ZwoHash provides essentially the same hashing speed while aiming for more uniform outputs. When used in a hash table ZwoHash is almost always able to match the performance of FxHash while outperforming it by quite a bit for some common inputs for which FxHash's output is particularly poor.

The hash algorithm used by ZwoHash is very similar to that of FxHash, both process one usize at a time and perform the same number and kind of operations per usize. ZwoHash though, replaces the last iteration with a slightly more expensive operation that provides better output guarantees. The additional overhead (independent of the size of the hashed data) consists of performing a wide multiplication instead of a truncated multiplication and one additional subtraction. This is very little overhead, and almost doesn't register when using ZwoHash in a hash table.

ZwoHash guarantees that any input bit can affect any bit of the output. FxHash does not guarantee this, and even beyond that, ZwoHash's output is more uniform. When used in a hash table, this often reduces the number of collisions and thus the number of required probes for each access. This can result in ZwoHash outperforming FxHash in that setting.

Sometimes, given inputs for which FxHash is especially ill-suited, ZwoHash outperforms FxHash by a large margin. This includes integer keys that all are a multiple of a power of two, floating point values with a short base-2 representation, pointers returned from the allocator and other inputs that only differ in the higher bits of the last processed usize.

Usage

If the std feature (enabled by default) is used this crate also exports the type aliases HashMap and HashSet which are re-exports of std::collection with the hashing algorithm set to ZwoHash. See their respective documentation for how to use them.

This crate always exports the ZwoHasher type which implements the std/core traits Hasher and Default, see core::hash for how to use this within Rust's hashing framework.

Benchmarks

ZwoHash comes with set of criterion benchmarks that test it against FxHash. You can run them on your machine using cargo bench. This takes several minutes.

Feedback

The above claims are based on the limited benchmarking I performed so far. Should you decide to give ZwoHash a try, I would be very much interested in hearing back from you. I'm especially interested in real-world benchmarks where ZwoHash is outperformed by FxHash, but I'd also love to hear where ZwoHash improves performance. Feel free to file issues for this.

no_std

ZwoHash can be used from no_std code by disabling the default std feature of this crate.

License

This software is available under the Zero-Clause BSD license, see COPYRIGHT for full licensing information and exceptions to this.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this software by you shall be licensed as defined in COPYRIGHT.

No runtime deps