3 <meta http-equiv=
"Content-Type" content=
"text/html; charset=US-ASCII">
4 <title>Chapter
 1.
 Boost.Bimap
</title>
5 <link rel=
"stylesheet" href=
"boostbook.css" type=
"text/css">
6 <meta name=
"generator" content=
"DocBook XSL Stylesheets V1.77.1">
7 <link rel=
"home" href=
"index.html" title=
"Chapter 1. Boost.Bimap">
8 <link rel=
"next" href=
"boost_bimap/introduction.html" title=
"Introduction">
10 <body bgcolor=
"white" text=
"black" link=
"#0000FF" vlink=
"#840084" alink=
"#0000FF">
11 <table cellpadding=
"2" width=
"100%"><tr>
12 <td valign=
"top"><img alt=
"Boost C++ Libraries" width=
"277" height=
"86" src=
"../../../../boost.png"></td>
13 <td align=
"center"><a href=
"../../../../index.html">Home
</a></td>
14 <td align=
"center"><a href=
"../../../../libs/libraries.htm">Libraries
</a></td>
15 <td align=
"center"><a href=
"http://www.boost.org/users/people.html">People
</a></td>
16 <td align=
"center"><a href=
"http://www.boost.org/users/faq.html">FAQ
</a></td>
17 <td align=
"center"><a href=
"../../../../more/index.htm">More
</a></td>
20 <div class=
"spirit-nav"><a accesskey=
"n" href=
"boost_bimap/introduction.html"><img src=
"../../../../doc/src/images/next.png" alt=
"Next"></a></div>
22 <div class=
"titlepage"><div>
23 <div><h2 class=
"title">
24 <a name=
"bimap"></a>Chapter
 1.
 Boost.Bimap
</h2></div>
25 <div><div class=
"author"><h3 class=
"author">
26 <span class=
"firstname">Matias
</span> <span class=
"surname">Capeletto
</span>
28 <div><p class=
"copyright">Copyright
© 2006-
2012 Matias Capeletto
</p></div>
29 <div><div class=
"legalnotice">
30 <a name=
"bimap.legal"></a><p>
31 Distributed under the Boost Software License, Version
1.0. (See accompanying
32 file LICENSE_1_0.txt or copy at
<a href=
"http://www.boost.org/LICENSE_1_0.txt" target=
"_top">http://www.boost.org/LICENSE_1_0.txt
</a>)
37 <p><b>Table of Contents
</b></p>
39 <dt><span class=
"section"><a href=
"index.html#bimap.preface">Preface
</a></span></dt>
40 <dt><span class=
"section"><a href=
"boost_bimap/introduction.html">Introduction
</a></span></dt>
41 <dt><span class=
"section"><a href=
"boost_bimap/one_minute_tutorial.html">One minute tutorial
</a></span></dt>
42 <dt><span class=
"section"><a href=
"boost_bimap/the_tutorial.html">The tutorial
</a></span></dt>
44 <dt><span class=
"section"><a href=
"boost_bimap/the_tutorial.html#boost_bimap.the_tutorial.roadmap">Roadmap
</a></span></dt>
45 <dt><span class=
"section"><a href=
"boost_bimap/the_tutorial/discovering_the_bimap_framework.html">Discovering
46 the bimap framework
</a></span></dt>
47 <dt><span class=
"section"><a href=
"boost_bimap/the_tutorial/controlling_collection_types.html">Controlling
48 collection types
</a></span></dt>
49 <dt><span class=
"section"><a href=
"boost_bimap/the_tutorial/the_collection_of_relations_type.html">The
50 collection of relations type
</a></span></dt>
51 <dt><span class=
"section"><a href=
"boost_bimap/the_tutorial/differences_with_standard_maps.html">Differences
52 with standard maps
</a></span></dt>
53 <dt><span class=
"section"><a href=
"boost_bimap/the_tutorial/useful_functions.html">Useful functions
</a></span></dt>
54 <dt><span class=
"section"><a href=
"boost_bimap/the_tutorial/bimaps_with_user_defined_names.html">Bimaps
55 with user defined names
</a></span></dt>
56 <dt><span class=
"section"><a href=
"boost_bimap/the_tutorial/unconstrained_sets.html">Unconstrained
58 <dt><span class=
"section"><a href=
"boost_bimap/the_tutorial/additional_information.html">Additional
59 information
</a></span></dt>
60 <dt><span class=
"section"><a href=
"boost_bimap/the_tutorial/complete_instantiation_scheme.html">Complete
61 instantiation scheme
</a></span></dt>
63 <dt><span class=
"section"><a href=
"boost_bimap/bimap_and_boost.html">Bimap and Boost
</a></span></dt>
65 <dt><span class=
"section"><a href=
"boost_bimap/bimap_and_boost.html#boost_bimap.bimap_and_boost.bimap_and_multiindex">Bimap
66 and MultiIndex
</a></span></dt>
67 <dt><span class=
"section"><a href=
"boost_bimap/bimap_and_boost/boost_libraries_that_work_well_with_boost_bimap.html">Boost
68 Libraries that work well with Boost.Bimap
</a></span></dt>
69 <dt><span class=
"section"><a href=
"boost_bimap/bimap_and_boost/dependencies.html">Dependencies
</a></span></dt>
71 <dt><span class=
"section"><a href=
"boost_bimap/reference.html">Reference
</a></span></dt>
73 <dt><span class=
"section"><a href=
"boost_bimap/reference.html#boost_bimap.reference.headers">Headers
</a></span></dt>
74 <dt><span class=
"section"><a href=
"boost_bimap/reference/bimap_reference.html">Bimap Reference
</a></span></dt>
75 <dt><span class=
"section"><a href=
"boost_bimap/reference/set_of_reference.html">set_of Reference
</a></span></dt>
76 <dt><span class=
"section"><a href=
"boost_bimap/reference/unordered_set_of_reference.html">unordered_set_of
77 Reference
</a></span></dt>
78 <dt><span class=
"section"><a href=
"boost_bimap/reference/list_of_reference.html">list_of Reference
</a></span></dt>
79 <dt><span class=
"section"><a href=
"boost_bimap/reference/vector_of_reference.html">vector_of
80 Reference
</a></span></dt>
81 <dt><span class=
"section"><a href=
"boost_bimap/reference/unconstrained_set_of_reference.html">unconstrained_set_of
82 Reference
</a></span></dt>
84 <dt><span class=
"section"><a href=
"boost_bimap/compiler_specifics.html">Compiler specifics
</a></span></dt>
85 <dt><span class=
"section"><a href=
"boost_bimap/performance.html">Performance
</a></span></dt>
86 <dt><span class=
"section"><a href=
"boost_bimap/examples.html">Examples
</a></span></dt>
88 <dt><span class=
"section"><a href=
"boost_bimap/examples.html#boost_bimap.examples.examples_list">Examples list
</a></span></dt>
89 <dt><span class=
"section"><a href=
"boost_bimap/examples/simple_bimap.html">Simple Bimap
</a></span></dt>
90 <dt><span class=
"section"><a href=
"boost_bimap/examples/mighty_bimap.html">Mighty Bimap
</a></span></dt>
91 <dt><span class=
"section"><a href=
"boost_bimap/examples/multiindex_to_bimap_path___bidirectional_map.html">MultiIndex
92 to Bimap Path - Bidirectional Map
</a></span></dt>
93 <dt><span class=
"section"><a href=
"boost_bimap/examples/multiindex_to_bimap_path___hashed_indices.html">MultiIndex
94 to Bimap Path - Hashed indices
</a></span></dt>
96 <dt><span class=
"section"><a href=
"boost_bimap/test_suite.html">Test suite
</a></span></dt>
97 <dt><span class=
"section"><a href=
"boost_bimap/future_work.html">Future work
</a></span></dt>
98 <dt><span class=
"section"><a href=
"boost_bimap/release_notes.html">Release notes
</a></span></dt>
99 <dt><span class=
"section"><a href=
"boost_bimap/rationale.html">Rationale
</a></span></dt>
101 <dt><span class=
"section"><a href=
"boost_bimap/rationale.html#boost_bimap.rationale.general_design">General Design
</a></span></dt>
102 <dt><span class=
"section"><a href=
"boost_bimap/rationale/additional_features.html">Additional
103 Features
</a></span></dt>
104 <dt><span class=
"section"><a href=
"boost_bimap/rationale/code.html">Code
</a></span></dt>
105 <dt><span class=
"section"><a href=
"boost_bimap/rationale/the_student_and_the_mentor.html">The
106 student and the mentor
</a></span></dt>
108 <dt><span class=
"section"><a href=
"boost_bimap/history.html">History
</a></span></dt>
110 <dt><span class=
"section"><a href=
"boost_bimap/history.html#boost_bimap.history.the_long_path_from_code_project_to_boost">The
111 long path from Code Project to Boost
</a></span></dt>
112 <dt><span class=
"section"><a href=
"boost_bimap/history/multiindex_and_bimap.html">MultiIndex
113 and Bimap
</a></span></dt>
115 <dt><span class=
"section"><a href=
"boost_bimap/acknowledgements.html">Acknowledgements
</a></span></dt>
118 <div class=
"section bimap_preface">
119 <div class=
"titlepage"><div><div><h2 class=
"title" style=
"clear: both">
120 <a name=
"bimap.preface"></a><a class=
"link" href=
"index.html#bimap.preface" title=
"Preface">Preface
</a>
121 </h2></div></div></div>
123 <a name=
"bimap.preface.h0"></a>
124 <span class=
"phrase"><a name=
"bimap.preface.description"></a></span><a class=
"link" href=
"index.html#bimap.preface.description">Description
</a>
127 <span class=
"inlinemediaobject"><img src=
"images/bimap/boost.bimap.logo.png" alt=
"boost.bimap.logo"></span>
130 Boost.Bimap is a bidirectional maps library for C++. With Boost.Bimap you can
131 create associative containers in which both types can be used as key. A
<code class=
"computeroutput"><span class=
"identifier">bimap
</span><span class=
"special"><</span><span class=
"identifier">X
</span><span class=
"special">,
</span><span class=
"identifier">Y
</span><span class=
"special">></span></code> can be thought of as a combination of a
132 <code class=
"computeroutput"><span class=
"identifier">std
</span><span class=
"special">::
</span><span class=
"identifier">map
</span><span class=
"special"><</span><span class=
"identifier">X
</span><span class=
"special">,
</span><span class=
"identifier">Y
</span><span class=
"special">></span></code>
133 and a
<code class=
"computeroutput"><span class=
"identifier">std
</span><span class=
"special">::
</span><span class=
"identifier">map
</span><span class=
"special"><</span><span class=
"identifier">Y
</span><span class=
"special">,
</span><span class=
"identifier">X
</span><span class=
"special">></span></code>.
134 The learning curve of bimap is almost flat if you know how to use standard
135 containers. A great deal of effort has been put into mapping the naming scheme
136 of the STL in Boost.Bimap. The library is designed to match the common STL
140 <a name=
"bimap.preface.h1"></a>
141 <span class=
"phrase"><a name=
"bimap.preface.influences_and_related_work"></a></span><a class=
"link" href=
"index.html#bimap.preface.influences_and_related_work">Influences
145 The design of Boost.Bimap interface follows the standard template library.
146 It has been strongly influenced by Joaquin Lopez Mu
ñoz's Boost.MultiIndex
147 library (the heart of bimaps) and codeproject::bimap library.
151 <table xmlns:
rev=
"http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width=
"100%"><tr>
152 <td align=
"left"><p><small>Last revised: February
14,
2013 at
18:
55:
19 GMT
</small></p></td>
153 <td align=
"right"><div class=
"copyright-footer"></div></td>
156 <div class=
"spirit-nav"><a accesskey=
"n" href=
"boost_bimap/introduction.html"><img src=
"../../../../doc/src/images/next.png" alt=
"Next"></a></div>