From 939bba607a575a03d5e3776867cf91314b9398a2 Mon Sep 17 00:00:00 2001 From: Daniel James Date: Sun, 9 Apr 2006 12:14:23 +0000 Subject: [PATCH] Merge hash documentation changes to release branch. [SVN r33612] --- hash/doc/intro.qbk | 19 +++++++++++-------- hash/doc/ref.xml | 6 +++--- 2 files changed, 14 insertions(+), 11 deletions(-) diff --git a/hash/doc/intro.qbk b/hash/doc/intro.qbk index 6e11647..bb4e998 100644 --- a/hash/doc/intro.qbk +++ b/hash/doc/intro.qbk @@ -1,23 +1,26 @@ [section:intro Introduction] -[def __tr1__ [@http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2005/n1745.pdf - C++ Standard Library Technical Report]] -[def __tr1-short__ [@http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2005/n1745.pdf - Technical Report]] +[def __tr1-full__ + [@http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2005/n1836.pdf + Draft Technical Report on C++ Library Extensions]] +[def __tr1__ + [@http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2005/n1836.pdf + TR1]] [def __multi-index__ [@../../libs/multi_index/doc/index.html Boost Multi-Index Containers Library]] [def __multi-index-short__ [@../../libs/multi_index/doc/index.html Boost.MultiIndex]] -[def __issues__ [@http://www.open-std.org/JTC1/SC22/WG21/docs/papers/2005/n1756.pdf +[def __issues__ + [@http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2005/n1837.pdf Library Extension Technical Report Issues List]] [def __hash-function__ [@http://en.wikipedia.org/wiki/Hash_function hash function]] [def __hash-table__ [@http://en.wikipedia.org/wiki/Hash_table hash table]] [classref boost::hash] is an implementation of the __hash-function__ object -specified by the __tr1-short__. It is intended for use as the default hash function +specified by the __tr1-full__ (TR1). It is intended for use as the default hash function for unordered associative containers, and the __multi-index__'s hash indexes. -As it is compliant with the __tr1-short__, it will work with: +As it is compliant with __tr1__, it will work with: * integers * floats @@ -25,7 +28,7 @@ As it is compliant with the __tr1-short__, it will work with: * strings It also implements the extension proposed by Peter Dimov in issue 6.18 of the -__issues__, this adds support for: +__issues__ (page 63), this adds support for: * arrays * `std::pair` diff --git a/hash/doc/ref.xml b/hash/doc/ref.xml index 0dd632d..3af0e8e 100644 --- a/hash/doc/ref.xml +++ b/hash/doc/ref.xml @@ -1,9 +1,9 @@
For the full specification, see section 6.3 of the - C++ Standard Library Technical Report + C++ Standard Library Technical Report and issue 6.18 of the - Library Extension Technical Report Issues List. + Library Extension Technical Report Issues List (page 63).
@@ -27,7 +27,7 @@ std::unary_function<T, std::size_t> - An STL compliant hash function object. + A TR1 compliant hash function object. std::size_t