https://github.com/boostorg/hash2
A hash function library
https://github.com/boostorg/hash2
Last synced: 6 months ago
JSON representation
A hash function library
- Host: GitHub
- URL: https://github.com/boostorg/hash2
- Owner: boostorg
- Created: 2018-01-06T14:33:47.000Z (about 8 years ago)
- Default Branch: develop
- Last Pushed: 2025-03-15T16:57:48.000Z (10 months ago)
- Last Synced: 2025-03-16T09:06:19.499Z (10 months ago)
- Language: C++
- Size: 810 KB
- Stars: 39
- Watchers: 5
- Forks: 9
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hash2, a hash function library
This library contains an extensible framework for implementing
hashing algorithms that can support user-defined types, based on the paper
["Types don't know #"](http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n3980.html)
by Howard Hinnant, Vinnie Falco and John Bytheway.
It also contains implementations of several popular hashing algorithms:
* [FNV-1a](https://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function)
* [xxHash](https://cyan4973.github.io/xxHash/)
* [SipHash](https://en.wikipedia.org/wiki/SipHash)
* [MD5](https://tools.ietf.org/html/rfc1321)
* [SHA-1](https://tools.ietf.org/html/rfc3174)
* [SHA-2](https://tools.ietf.org/html/rfc6234)
* [SHA-3](https://csrc.nist.gov/pubs/fips/202/final)
* [RIPEMD-160, RIPEMD-128](https://homes.esat.kuleuven.be/%7Ebosselae/ripemd160.html)
* [HMAC](https://tools.ietf.org/html/rfc2104)
The hashing algorithms conform to the following concept:
```
struct HashAlgorithm
{
using result_type = /*integral or array*/; // result type
HashAlgorithm(); // default-constructible
explicit HashAlgorithm( uint64_t seed ); // seed-constructible
HashAlgorithm( void const* seed, size_t n ); // seed-constructible
HashAlgorithm( HashAlgorithm const& r ); // copy-constructible
HashAlgorithm& operator=( HashAlgorithm const& r ); // assignable
void update( void const* data, size_t n ); // feed bytes
result_type result(); // obtain result; also advances state,
// and can be called multiple times
};
```
See [the documentation](https://boost.org/libs/hash2/) for more information.
## Supported compilers
The library requires C++11. The following compilers:
* g++ 4.8 or later
* clang++ 3.9 or later
* Visual Studio 2015 and above
are being tested on [Github Actions](https://github.com/boostorg/hash2/actions/) and [Appveyor](https://ci.appveyor.com/project/pdimov/hash2/).
## License
Distributed under the [Boost Software License, Version 1.0](http://boost.org/LICENSE_1_0.txt).