blob: d0bfd1ebdd1d05fbcbccdee8db814e355ba3dfcb [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Reference</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../index.html" title="Chapter&#160;1.&#160;Boost.Bimap">
<link rel="up" href="../index.html" title="Chapter&#160;1.&#160;Boost.Bimap">
<link rel="prev" href="bimap_and_boost/dependencies.html" title="Dependencies">
<link rel="next" href="reference/bimap_reference.html" title="Bimap Reference">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
<td align="center"><a href="../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="bimap_and_boost/dependencies.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="reference/bimap_reference.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="boost_bimap.reference"></a><a class="link" href="reference.html" title="Reference">Reference</a>
</h2></div></div></div>
<div class="toc"><dl>
<dt><span class="section"><a href="reference.html#boost_bimap.reference.headers">Headers</a></span></dt>
<dt><span class="section"><a href="reference/bimap_reference.html">Bimap Reference</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="reference/bimap_reference.html#boost_bimap.reference.bimap_reference.view_concepts">View
concepts</a></span></dt>
<dt><span class="section"><a href="reference/bimap_reference.html#boost_bimap.reference.bimap_reference.complexity_signature">Complexity
signature</a></span></dt>
<dt><span class="section"><a href="reference/bimap_reference.html#boost_bimap.reference.bimap_reference.set_type_specification">Set
type specification</a></span></dt>
<dt><span class="section"><a href="reference/bimap_reference.html#boost_bimap.reference.bimap_reference.tags">Tags</a></span></dt>
<dt><span class="section"><a href="reference/bimap_reference.html#boost_bimap.reference.bimap_reference.header__boost_bimap_bimap_hpp__synopsis">Header
"boost/bimap/bimap.hpp" synopsis</a></span></dt>
<dt><span class="section"><a href="reference/bimap_reference.html#boost_bimap.reference.bimap_reference.class_template_bimap">Class
template bimap</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="reference/set_of_reference.html">set_of Reference</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="reference/set_of_reference.html#boost_bimap.reference.set_of_reference.header__boost_bimap_set_of_hpp__synopsis">Header
"boost/bimap/set_of.hpp" synopsis</a></span></dt>
<dt><span class="section"><a href="reference/set_of_reference.html#boost_bimap.reference.set_of_reference.header__boost_bimap_multiset_of_hpp__synopsis">Header
"boost/bimap/multiset_of.hpp" synopsis</a></span></dt>
<dt><span class="section"><a href="reference/set_of_reference.html#boost_bimap.reference.set_of_reference.collection_type_specifiers_set_of_and_multiset_of">Collection
type specifiers set_of and multiset_of</a></span></dt>
<dt><span class="section"><a href="reference/set_of_reference.html#boost_bimap.reference.set_of_reference.__multi__set_of_views">[multi]set_of
Views</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="reference/unordered_set_of_reference.html">unordered_set_of
Reference</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="reference/unordered_set_of_reference.html#boost_bimap.reference.unordered_set_of_reference.header__boost_bimap_unordered_set_of_hpp__synopsis">Header
"boost/bimap/unordered_set_of.hpp" synopsis</a></span></dt>
<dt><span class="section"><a href="reference/unordered_set_of_reference.html#boost_bimap.reference.unordered_set_of_reference.header__boost_bimap_unordered_multiset_of_hpp__synopsis">Header
"boost/bimap/unordered_multiset_of.hpp" synopsis</a></span></dt>
<dt><span class="section"><a href="reference/unordered_set_of_reference.html#boost_bimap.reference.unordered_set_of_reference.collection_type_specifiers_unordered_set_of_and_unordered_multiset_of">Collection
type specifiers unordered_set_of and unordered_multiset_of</a></span></dt>
<dt><span class="section"><a href="reference/unordered_set_of_reference.html#boost_bimap.reference.unordered_set_of_reference.unordered___multi__set_of_views">unordered_[multi]set_of
Views</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="reference/list_of_reference.html">list_of Reference</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="reference/list_of_reference.html#boost_bimap.reference.list_of_reference.header__boost_bimap_list_of_hpp__synopsis">Header
"boost/bimap/list_of.hpp" synopsis</a></span></dt>
<dt><span class="section"><a href="reference/list_of_reference.html#boost_bimap.reference.list_of_reference.list_of_views">list_of
Views</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="reference/vector_of_reference.html">vector_of
Reference</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="reference/vector_of_reference.html#boost_bimap.reference.vector_of_reference.header__boost_bimap_vector_of_hpp__synopsis">Header
"boost/bimap/vector_of.hpp" synopsis</a></span></dt>
<dt><span class="section"><a href="reference/vector_of_reference.html#boost_bimap.reference.vector_of_reference.vector_of_views">vector_of
views</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="reference/unconstrained_set_of_reference.html">unconstrained_set_of
Reference</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="reference/unconstrained_set_of_reference.html#boost_bimap.reference.unconstrained_set_of_reference.header__boost_bimap_unconstrained_set_of_hpp__synopsis">Header
"boost/bimap/unconstrained_set_of.hpp" synopsis</a></span></dt>
<dt><span class="section"><a href="reference/unconstrained_set_of_reference.html#boost_bimap.reference.unconstrained_set_of_reference.unconstrained_set_of_views">unconstrained_set_of
Views</a></span></dt>
</dl></dd>
</dl></div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_bimap.reference.headers"></a><a class="link" href="reference.html#boost_bimap.reference.headers" title="Headers">Headers</a>
</h3></div></div></div>
<p>
The following are the interface headers of Boost.Bimap:
</p>
<p>
<span class="bold"><strong>Convenience</strong></span>
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
"boost/bimap.hpp" <span class="emphasis"><em>(includes "boost/bimap/bimap.hpp"
and imports the bimap class to boost namespace)</em></span>
</li></ul></div>
<p>
<span class="bold"><strong>Container</strong></span>
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
"boost/bimap/bimap.hpp" <span class="emphasis"><em>(includes "boost/bimap/set_of.hpp"
and "boost/bimap/unconstrained_set_of.hpp")</em></span>
</li></ul></div>
<p>
<span class="bold"><strong>Set Types</strong></span>
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
"boost/bimap/set_of.hpp"
</li>
<li class="listitem">
"boost/bimap/multiset_of.hpp"
</li>
<li class="listitem">
"boost/bimap/unordered_set_of.hpp"
</li>
<li class="listitem">
"boost/bimap/unordered_multiset_of.hpp"
</li>
<li class="listitem">
"boost/bimap/list_of.hpp"
</li>
<li class="listitem">
"boost/bimap/vector_of.hpp"
</li>
<li class="listitem">
"boost/bimap/unconstrained_set_of.hpp"
</li>
</ul></div>
<p>
<span class="bold"><strong>Boost Integration</strong></span>
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
"boost/bimap/support/lambda.hpp"
</li>
<li class="listitem">
"boost/bimap/property_map/set_support.hpp"
</li>
<li class="listitem">
"boost/bimap/property_map/unordered_set_support.hpp"
</li>
</ul></div>
<p>
A program using Boost.Bimap must therefore include "boost/bimap/bimap.hpp"
and the headers defining the collection types to be used.
</p>
<p>
Additional headers allow the integration of Boost.Bimap with other boost
libraries, like Boost.Lambda and Boost.Property_map.
</p>
<p>
In order to use the serialization capabilities of Boost.Bimap, the appropriate
Boost.Serialization library module must be linked. Other than that, Boost.Bimap
is a header-only library, requiring no additional object modules.
</p>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2006 -2007 Matias Capeletto<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
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>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="bimap_and_boost/dependencies.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="reference/bimap_reference.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>