From 607b73f1e05c3a9404e7464814a6fae785af30f0 Mon Sep 17 00:00:00 2001 From: Peter Dimov Date: Tue, 20 Sep 2022 16:08:10 +0300 Subject: [PATCH] Add README.md --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..aaaf577 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# Boost.ContainerHash + +The Boost.ContainerHash library, part of [Boost C++ Libraries](https://boost.org), +provides `boost::hash`, an enhanced implementation of the +[hash function](https://en.wikipedia.org/wiki/Hash_function) object specified +by C++11 as `std::hash`, and several support facilities (`hash_combine`, +`hash_range`, `hash_unordered_range`). + +`boost::hash` supports most standard types and some user-defined types out of +the box, and is extensible; it's possible for a user-defined type `X` to make +iself hashable via `boost::hash` by defining an appropriate overload of the +function `hash_value`. + +See [the documentation of the library](https://www.boost.org/libs/container_hash) +for more information. + +## License + +Distributed under the +[Boost Software License, Version 1.0](http://boost.org/LICENSE_1_0.txt).