1 | |
---|
2 | [/ Copyright 2005-2006 Daniel James. |
---|
3 | / Distributed under the Boost Software License, Version 1.0. (See accompanying |
---|
4 | / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) ] |
---|
5 | |
---|
6 | [section:intro Introduction] |
---|
7 | |
---|
8 | [def __tr1-full__ |
---|
9 | [@http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2005/n1836.pdf |
---|
10 | Draft Technical Report on C++ Library Extensions]] |
---|
11 | [def __tr1__ |
---|
12 | [@http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2005/n1836.pdf |
---|
13 | TR1]] |
---|
14 | [def __multi-index__ [@../../libs/multi_index/doc/index.html |
---|
15 | Boost Multi-Index Containers Library]] |
---|
16 | [def __multi-index-short__ [@../../libs/multi_index/doc/index.html |
---|
17 | Boost.MultiIndex]] |
---|
18 | [def __issues__ |
---|
19 | [@http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2005/n1837.pdf |
---|
20 | Library Extension Technical Report Issues List]] |
---|
21 | [def __hash-function__ [@http://en.wikipedia.org/wiki/Hash_function hash function]] |
---|
22 | [def __hash-table__ [@http://en.wikipedia.org/wiki/Hash_table hash table]] |
---|
23 | |
---|
24 | [classref boost::hash] is an implementation of the __hash-function__ object |
---|
25 | specified by the __tr1-full__ (TR1). It is intended for use as the default hash function |
---|
26 | for unordered associative containers, and the __multi-index__'s hash indexes. |
---|
27 | |
---|
28 | As it is compliant with __tr1__, it will work with: |
---|
29 | |
---|
30 | * integers |
---|
31 | * floats |
---|
32 | * pointers |
---|
33 | * strings |
---|
34 | |
---|
35 | It also implements the extension proposed by Peter Dimov in issue 6.18 of the |
---|
36 | __issues__ (page 63), this adds support for: |
---|
37 | |
---|
38 | * arrays |
---|
39 | * `std::pair` |
---|
40 | * the standard containers. |
---|
41 | * extending [classref boost::hash] for custom types. |
---|
42 | |
---|
43 | [endsect] |
---|
44 | |
---|