Boost logo

Boost-Commit :

From: danieljames_at_[hidden]
Date: 2007-06-20 16:47:51


Author: danieljames
Date: 2007-06-20 16:47:51 EDT (Wed, 20 Jun 2007)
New Revision: 7116
URL: http://svn.boost.org/trac/boost/changeset/7116

Log:
Tweak the hash equality documentation a little.

Text files modified:
   sandbox/unordered/libs/unordered/doc/hash_equality.qbk | 10 ++++------
   1 files changed, 4 insertions(+), 6 deletions(-)

Modified: sandbox/unordered/libs/unordered/doc/hash_equality.qbk
==============================================================================
--- sandbox/unordered/libs/unordered/doc/hash_equality.qbk (original)
+++ sandbox/unordered/libs/unordered/doc/hash_equality.qbk 2007-06-20 16:47:51 EDT (Wed, 20 Jun 2007)
@@ -8,7 +8,7 @@
 
 While the associative containers use an ordering relation to specify how the
 elements are stored, the unordered associative containers use an equality
-predicate and a hash function. For example [classref boost::unordered_set]
+predicate and a hash function. For example, [classref boost::unordered_set]
 is declared as:
 
     template<typename Value,
@@ -20,9 +20,7 @@
 The hash function comes first as you might want to change the hash function
 but not the equality predicate, while if you were to change the behaviour
 of the equality predicate you would have to change the hash function to match
-it.
-
-For example, if you wanted to use the
+it. So, if you wanted to use the
 [@http://www.isthe.com/chongo/tech/comp/fnv/ FNV-1 hash] you could write:
 
     ``[classref boost::unordered_set]``<std::string, hash::fnv_1> words;
@@ -31,7 +29,7 @@
 in the examples directory.
 
 Alternatively, you might wish to use a different equality function. If so, make
-sure you use a hash function that matches it. For example, a
+sure you use a hash function that matches it. So to implement a
 case-insensitive dictionary:
 
     struct iequal_to
@@ -66,7 +64,7 @@
     boost::unordered_map<std::string, word_info, ihash, iequal_to>
         idictionary;
 
-A more generic version of this example is available at:
+A more generic version is available at:
 [@../../libs/unordered/examples/case_insensitive.hpp /libs/unordered/examples/case_insensitive.hpp]
 
 [h2 Custom Types]


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