]>
Commit | Line | Data |
---|---|---|
7c673cae FG |
1 | [/license |
2 | ||
3 | Boost.Bimap | |
4 | ||
5 | Copyright (c) 2006-2007 Matias Capeletto | |
6 | ||
7 | Distributed under the Boost Software License, Version 1.0. | |
8 | (See accompanying file LICENSE_1_0.txt or copy at | |
9 | http://www.boost.org/LICENSE_1_0.txt) | |
10 | ||
11 | ] | |
12 | ||
13 | [/ QuickBook Document version 1.4 ] | |
14 | ||
15 | [section Reference] | |
16 | ||
17 | [section Headers] | |
18 | ||
19 | The following are the interface headers of Boost.Bimap: | |
20 | ||
21 | [*Convenience] | |
22 | ||
23 | * "boost/bimap.hpp" ['(includes "boost/bimap/bimap.hpp" and imports the bimap class to boost namespace)] | |
24 | ||
25 | [*Container] | |
26 | ||
27 | * "boost/bimap/bimap.hpp" ['(includes "boost/bimap/set_of.hpp" and "boost/bimap/unconstrained_set_of.hpp")] | |
28 | ||
29 | [*Set Types] | |
30 | ||
31 | * "boost/bimap/set_of.hpp" | |
32 | * "boost/bimap/multiset_of.hpp" | |
33 | * "boost/bimap/unordered_set_of.hpp" | |
34 | * "boost/bimap/unordered_multiset_of.hpp" | |
35 | * "boost/bimap/list_of.hpp" | |
36 | * "boost/bimap/vector_of.hpp" | |
37 | * "boost/bimap/unconstrained_set_of.hpp" | |
38 | ||
39 | [*Boost Integration] | |
40 | ||
41 | * "boost/bimap/support/lambda.hpp" | |
42 | * "boost/bimap/property_map/set_support.hpp" | |
43 | * "boost/bimap/property_map/unordered_set_support.hpp" | |
44 | ||
45 | A program using Boost.Bimap must therefore include | |
46 | "boost/bimap/bimap.hpp" and the headers defining the collection types to be used. | |
47 | ||
48 | Additional headers allow the integration of Boost.Bimap with other boost libraries, | |
49 | like Boost.Lambda and Boost.Property_map. | |
50 | ||
51 | In order to use the serialization capabilities of Boost.Bimap, the appropriate | |
52 | Boost.Serialization library module must be linked. Other than that, Boost.Bimap | |
53 | is a header-only library, requiring no additional object modules. | |
54 | ||
55 | [endsect] | |
56 | ||
57 | [include reference/bimap.qbk] | |
58 | [include reference/set_of.qbk] | |
59 | [include reference/unordered_set_of.qbk] | |
60 | [include reference/list_of.qbk] | |
61 | [include reference/vector_of.qbk] | |
62 | [include reference/unconstrained_set_of.qbk] | |
63 | ||
64 | [endsect] |