boostorg/functional
1
0
Fork 1
mirror of https://github.com/boostorg/functional.git synced 2025-08-02 14:04:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

Improve the 'blurbs' in the hash documentation.

Browse Source 
[SVN r33344]
This commit is contained in:
Daniel James
2006-03-14 22:42:52 +00:00
parent 8e49dd4dac
commit 48f007cc40
1 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
hash/doc/tutorial.qbk
View File

@@ -109,12 +109,13 @@ The full example can be found in:
and
[@../../libs/functional/hash/examples/books.cpp /libs/functional/hash/examples/books.cpp].
[blurb
[tip
When writing a hash function, first look at how the equality function works.
Objects that are equal must generate the same hash value.
When objects are not equal they should generate different hash values.
In this object equality was based just on the id, if it was based
on the objects name and author the hash function should take them into account
In this object equality was based just on the id so the hash function
only hash the id. If it was based on the objects name and author
then the hash function should take them into account
(how to do this is discussed in the next section).
]
@@ -166,7 +167,7 @@ of point, it can be repeatedly called for any number of elements. It calls
Full code for this example is at
[@../../libs/functional/hash/examples/point.cpp /libs/functional/hash/examples/point.cpp].
[blurb
[note
When using [funcref boost::hash_combine] the order of the
calls matters.
'''