Date: 2008-01-06 07:31:13
Date: 2008-01-06 07:31:13 EST (Sun, 06 Jan 2008)
New Revision: 42518
Add a little bit of text about hash and equality functions to the intro, and add links to Boost.Hash.
Text files modified:
branches/unordered/trunk/libs/unordered/doc/hash_equality.qbk | 8 ++++----
branches/unordered/trunk/libs/unordered/doc/intro.qbk | 10 ++++++++++
2 files changed, 14 insertions(+), 4 deletions(-)
--- branches/unordered/trunk/libs/unordered/doc/hash_equality.qbk (original)
+++ branches/unordered/trunk/libs/unordered/doc/hash_equality.qbk 2008-01-06 07:31:13 EST (Sun, 06 Jan 2008)
@@ -45,14 +45,14 @@
-Although, customizing Boost.Hash is probably a better solution:
+Although, customizing [link hash Boost.Hash] is probably a better solution:
-See the Boost.Hash documentation for more detail on how to do this. Remember
-that it relies on extensions to the draft standard - so it won't work on other
-implementations of the unordered associative containers.
+See the [link hash Boost.Hash] documentation for more detail on how to do this.
+Remember that it relies on extensions to the draft standard - so it won't work
+on other implementations of the unordered associative containers.
[table Methods for accessing the hash and equality functions.
--- branches/unordered/trunk/libs/unordered/doc/intro.qbk (original)
+++ branches/unordered/trunk/libs/unordered/doc/intro.qbk 2008-01-06 07:31:13 EST (Sun, 06 Jan 2008)
@@ -111,6 +111,16 @@
+To store an object in an unordered associative container requires both an
+key equality function and a hash function. The default function objects in
+the standard containers support integer types, floating point types, pointer
+types, the standard strings and std::error_code. Since Boost.Unordered uses
+[classref boost::hash] it also supports the standard containers and any types
+customized for [link hash Boost.Hash]. You can also use your custom equality
+predicates and hash functions. See the
+[link unordered.hash_equality Equality Predicates and Hash Functions] section
+for more details.
There are other differences, which are listed in the
[link unordered.comparison Comparison with Associative Containers] section.
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk