Quick Start
You are viewing the master version of this library.
The master and develop pages are shown here to provide access to the newest in-development in-progress documentation. See the "Documentation" link on this page.
Other aspects of the page will reflect the previous official version, or not be available until the next release.
Contributors: This Release
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 #" by Howard Hinnant, Vinnie Falco and John Bytheway.
It also contains implementations of several popular hashing algorithms:
The hashing algorithms conform to the following concept:
struct HashAlgorithm
{
using result_type = /*integral or array<unsigned char, N>*/; // 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 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 and Appveyor.
License
Distributed under the Boost Software License, Version 1.0.
Latest Boost.Hash2 posts
<h1>Hash2, a hash function library</h1> <p>This library contains an extensible framework for implementing hashing algorithms that can support user-defined types, based on the paper <a href="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n3980.html">"Types don't know #"</a> by Howard Hinnant, Vinnie Falco and John Bytheway.</p> <p>It also contains implementations of several popular hashing algorithms:</p> <ul> <li><a href="https://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function">FNV-1a</a></li> <li><a href="https://cyan4973.github.io/xxHash/">xxHash</a></li> <li><a href="https://en.wikipedia.org/wiki/SipHash">SipHash</a></li> <li><a href="https://tools.ietf.org/html/rfc1321">MD5</a></li> <li><a href="https://tools.ietf.org/html/rfc3174">SHA-1</a></li> <li><a href="https://tools.ietf.org/html/rfc6234">SHA-2</a></li> <li><a href="https://csrc.nist.gov/pubs/fips/202/final">SHA-3</a></li> <li><a href="https://homes.esat.kuleuven.be/%7Ebosselae/ripemd160.html">RIPEMD-160, RIPEMD-128</a></li> <li><a href="https://tools.ietf.org/html/rfc2104">HMAC</a></li> </ul> <p>The hashing algorithms conform to the following concept:</p> <pre class="highlightjs highlight"><code class="language- hljs">struct HashAlgorithm { using result_type = /*integral or array<unsigned char, N>*/; // 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 }; </code></pre> <p>See <a href="https://boost.org/libs/hash2/">the documentation</a> for more information.</p> <h2>Supported compilers</h2> <p>The library requires C++11. The following compilers:</p> <ul> <li>g++ 4.8 or later</li> <li>clang++ 3.9 or later</li> <li>Visual Studio 2015 and above</li> </ul> <p>are being tested on <a href="https://github.com/boostorg/hash2/actions/">Github Actions</a> and <a href="https://ci.appveyor.com/project/pdimov/hash2/">Appveyor</a>.</p> <h2>License</h2> <p>Distributed under the <a href="http://boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>.</p>
-
Code Commits Commits authored to any Boost repository. With 1 contribution, you will earn the bronze badge for Code Commits.
-
Documentation Doc contributions using standardised Boost tooling (Antora / BoostLook). With 1 contribution, you will earn the bronze badge for Documentation.
-
Library Authoring Authored an original Boost library accepted into the collection. With 1 contribution, you will earn the bronze badge for Library Authoring.
-
Library Maintenance Number of libraries actively maintained. With 1 contribution, you will earn the bronze badge for Library Maintenance.
-
Library Review Formal review submissions on Boost proposals. With 1 contribution, you will earn the bronze badge for Library Review.
-
Library Versioning Authored new versions / releases of Boost libraries. With 10 contributions, you will earn the bronze badge for Library Versioning.
-
Mailing List Participation Participation on the Boost developers mailing list. With 1 contribution, you will earn the bronze badge for Mailing List Participation.
-
News Posts Published Articles / news posts published on Boost.org. With 1 contribution, you will earn the bronze badge for News Posts Published.
<h1>Hash2, a hash function library</h1> <p>This library contains an extensible framework for implementing hashing algorithms that can support user-defined types, based on the paper <a href="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n3980.html">"Types don't know #"</a> by Howard Hinnant, Vinnie Falco and John Bytheway.</p> <p>It also contains implementations of several popular hashing algorithms:</p> <ul> <li><a href="https://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function">FNV-1a</a></li> <li><a href="https://cyan4973.github.io/xxHash/">xxHash</a></li> <li><a href="https://en.wikipedia.org/wiki/SipHash">SipHash</a></li> <li><a href="https://tools.ietf.org/html/rfc1321">MD5</a></li> <li><a href="https://tools.ietf.org/html/rfc3174">SHA-1</a></li> <li><a href="https://tools.ietf.org/html/rfc6234">SHA-2</a></li> <li><a href="https://csrc.nist.gov/pubs/fips/202/final">SHA-3</a></li> <li><a href="https://homes.esat.kuleuven.be/%7Ebosselae/ripemd160.html">RIPEMD-160, RIPEMD-128</a></li> <li><a href="https://tools.ietf.org/html/rfc2104">HMAC</a></li> </ul> <p>The hashing algorithms conform to the following concept:</p> <pre class="highlightjs highlight"><code class="language- hljs">struct HashAlgorithm { using result_type = /*integral or array<unsigned char, N>*/; // 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 }; </code></pre> <p>See <a href="https://boost.org/libs/hash2/">the documentation</a> for more information.</p> <h2>Supported compilers</h2> <p>The library requires C++11. The following compilers:</p> <ul> <li>g++ 4.8 or later</li> <li>clang++ 3.9 or later</li> <li>Visual Studio 2015 and above</li> </ul> <p>are being tested on <a href="https://github.com/boostorg/hash2/actions/">Github Actions</a> and <a href="https://ci.appveyor.com/project/pdimov/hash2/">Appveyor</a>.</p> <h2>License</h2> <p>Distributed under the <a href="http://boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>.</p>
-
Achievement-based Reflects the depth of your contributions. Accumulate achievements to unlock five tiers; Bronze, Silver, Gold, Platinum and Diamond.
-
Tenure-based Awarded in recognition of your time on the platform. The longer you've been part of the Boost community, the higher the tier you unlock.
-
Boost day celebration A celebration of the day you joined Boost. Awarded annually to mark another year as part of the community.
