|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r59821 - in sandbox/tokenmap/libs/tokenmap/doc: . html html/images html/images/extern html/images/people html/tokenmap html/tokenmap/reference
From: sl_at_[hidden]
Date: 2010-02-21 15:08:36
Author: sl_
Date: 2010-02-21 15:08:34 EST (Sun, 21 Feb 2010)
New Revision: 59821
URL: http://svn.boost.org/trac/boost/changeset/59821
Log:
doc first cut
Added:
sandbox/tokenmap/libs/tokenmap/doc/html/
sandbox/tokenmap/libs/tokenmap/doc/html/boostbook.css (contents, props changed)
sandbox/tokenmap/libs/tokenmap/doc/html/images/
sandbox/tokenmap/libs/tokenmap/doc/html/images/extern/
sandbox/tokenmap/libs/tokenmap/doc/html/images/extern/googlesoc.png (contents, props changed)
sandbox/tokenmap/libs/tokenmap/doc/html/images/people/
sandbox/tokenmap/libs/tokenmap/doc/html/images/people/slawomir.png (contents, props changed)
sandbox/tokenmap/libs/tokenmap/doc/html/images/space.png (contents, props changed)
sandbox/tokenmap/libs/tokenmap/doc/html/index.html (contents, props changed)
sandbox/tokenmap/libs/tokenmap/doc/html/standalone_HTML.manifest (contents, props changed)
sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/
sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/acknowledgements_.html (contents, props changed)
sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/examples_.html (contents, props changed)
sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/future_work_.html (contents, props changed)
sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/performance_.html (contents, props changed)
sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/quick_tutorial.html (contents, props changed)
sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/rationale_.html (contents, props changed)
sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/reference/
sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/reference.html (contents, props changed)
sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/reference/class_template_tokenmap.html (contents, props changed)
sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/reference/constructors__copy_and_assignment.html (contents, props changed)
sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/reference/header__boost_tokenmap_tokenmap_hpp__synopsis.html (contents, props changed)
sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/reference/nested_types.html (contents, props changed)
sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/reference/synopsis.html (contents, props changed)
Text files modified:
sandbox/tokenmap/libs/tokenmap/doc/tokenmap.qbk | 107 ++++++++++++++-------------------------
1 files changed, 40 insertions(+), 67 deletions(-)
Added: sandbox/tokenmap/libs/tokenmap/doc/html/boostbook.css
==============================================================================
--- (empty file)
+++ sandbox/tokenmap/libs/tokenmap/doc/html/boostbook.css 2010-02-21 15:08:34 EST (Sun, 21 Feb 2010)
@@ -0,0 +1,582 @@
+/*=============================================================================
+ Copyright (c) 2004 Joel de Guzman
+ http://spirit.sourceforge.net/
+
+ Use, modification and distribution is subject to the Boost Software
+ License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
+ http://www.boost.org/LICENSE_1_0.txt)
+=============================================================================*/
+
+/*=============================================================================
+ Body defaults
+=============================================================================*/
+
+ body
+ {
+ margin: 1em;
+ font-family: sans-serif;
+ }
+
+/*=============================================================================
+ Paragraphs
+=============================================================================*/
+
+ p
+ {
+ text-align: left;
+ font-size: 10pt;
+ line-height: 1.15;
+ }
+
+/*=============================================================================
+ Program listings
+=============================================================================*/
+
+ /* Code on paragraphs */
+ p tt.computeroutput
+ {
+ font-size: 10pt;
+ }
+
+ pre.synopsis
+ {
+ font-size: 10pt;
+ margin: 1pc 4% 0pc 4%;
+ padding: 0.5pc 0.5pc 0.5pc 0.5pc;
+ }
+
+ .programlisting,
+ .screen
+ {
+ font-size: 10pt;
+ display: block;
+ margin: 1pc 4% 0pc 4%;
+ padding: 0.5pc 0.5pc 0.5pc 0.5pc;
+ }
+
+ /* Program listings in tables don't get borders */
+ td .programlisting,
+ td .screen
+ {
+ margin: 0pc 0pc 0pc 0pc;
+ padding: 0pc 0pc 0pc 0pc;
+ }
+
+/*=============================================================================
+ Headings
+=============================================================================*/
+
+ h1, h2, h3, h4, h5, h6
+ {
+ text-align: left;
+ margin: 1em 0em 0.5em 0em;
+ font-weight: bold;
+ }
+
+ h1 { font: 140% }
+ h2 { font: bold 140% }
+ h3 { font: bold 130% }
+ h4 { font: bold 120% }
+ h5 { font: italic 110% }
+ h6 { font: italic 100% }
+
+ /* Top page titles */
+ title,
+ h1.title,
+ h2.title
+ h3.title,
+ h4.title,
+ h5.title,
+ h6.title,
+ .refentrytitle
+ {
+ font-weight: bold;
+ margin-bottom: 1pc;
+ }
+
+ h1.title { font-size: 140% }
+ h2.title { font-size: 140% }
+ h3.title { font-size: 130% }
+ h4.title { font-size: 120% }
+ h5.title { font-size: 110% }
+ h6.title { font-size: 100% }
+
+ .section h1
+ {
+ margin: 0em 0em 0.5em 0em;
+ font-size: 140%;
+ }
+
+ .section h2 { font-size: 140% }
+ .section h3 { font-size: 130% }
+ .section h4 { font-size: 120% }
+ .section h5 { font-size: 110% }
+ .section h6 { font-size: 100% }
+
+ /* Code on titles */
+ h1 tt.computeroutput { font-size: 140% }
+ h2 tt.computeroutput { font-size: 140% }
+ h3 tt.computeroutput { font-size: 130% }
+ h4 tt.computeroutput { font-size: 120% }
+ h5 tt.computeroutput { font-size: 110% }
+ h6 tt.computeroutput { font-size: 100% }
+
+/*=============================================================================
+ Author
+=============================================================================*/
+
+ h3.author
+ {
+ font-size: 100%
+ }
+
+/*=============================================================================
+ Lists
+=============================================================================*/
+
+ li
+ {
+ font-size: 10pt;
+ line-height: 1.3;
+ }
+
+ /* Unordered lists */
+ ul
+ {
+ text-align: left;
+ }
+
+ /* Ordered lists */
+ ol
+ {
+ text-align: left;
+ }
+
+/*=============================================================================
+ Links
+=============================================================================*/
+
+ a
+ {
+ text-decoration: none; /* no underline */
+ }
+
+ a:hover
+ {
+ text-decoration: underline;
+ }
+
+/*=============================================================================
+ Spirit style navigation
+=============================================================================*/
+
+ .spirit-nav
+ {
+ text-align: right;
+ }
+
+ .spirit-nav a
+ {
+ color: white;
+ padding-left: 0.5em;
+ }
+
+ .spirit-nav img
+ {
+ border-width: 0px;
+ }
+
+/*=============================================================================
+ Table of contents
+=============================================================================*/
+
+ .toc
+ {
+ margin: 1pc 4% 0pc 4%;
+ padding: 0.1pc 1pc 0.1pc 1pc;
+ font-size: 10pt;
+ line-height: 1.15;
+ }
+
+ .toc-main
+ {
+ text-align: center;
+ margin: 3pc 16% 3pc 16%;
+ padding: 3pc 1pc 3pc 1pc;
+ line-height: 0.1;
+ }
+
+ .boost-toc
+ {
+ float: right;
+ padding: 0.5pc;
+ }
+
+/*=============================================================================
+ Tables
+=============================================================================*/
+
+ .table-title,
+ div.table p.title
+ {
+ margin-left: 4%;
+ padding-right: 0.5em;
+ padding-left: 0.5em;
+ }
+
+ .informaltable table,
+ .table table
+ {
+ width: 92%;
+ margin-left: 4%;
+ margin-right: 4%;
+ }
+
+ div.informaltable table,
+ div.table table
+ {
+ padding: 4px;
+ }
+
+ /* Table Cells */
+ div.informaltable table tr td,
+ div.table table tr td
+ {
+ padding: 0.5em;
+ text-align: left;
+ }
+
+ div.informaltable table tr th,
+ div.table table tr th
+ {
+ padding: 0.5em 0.5em 0.5em 0.5em;
+ border: 1pt solid white;
+ font-size: 120%;
+ }
+
+/*=============================================================================
+ Blurbs
+=============================================================================*/
+
+ div.note,
+ div.tip,
+ div.important,
+ div.caution,
+ div.warning,
+ div.sidebar
+ {
+ font-size: 10pt;
+ line-height: 1.2;
+ display: block;
+ margin: 1pc 4% 0pc 4%;
+ padding: 0.5pc 0.5pc 0.5pc 0.5pc;
+ }
+
+ div.sidebar img
+ {
+ padding: 1pt;
+ }
+
+
+
+/*=============================================================================
+ Callouts
+=============================================================================*/
+ .line_callout_bug img
+ {
+ float: left;
+ position:relative;
+ left: 4px;
+ top: -12px;
+ clear: left;
+ margin-left:-22px;
+ }
+
+ .callout_bug img
+ {
+ }
+
+
+
+/*=============================================================================
+ Variable Lists
+=============================================================================*/
+
+ /* Make the terms in definition lists bold */
+ div.variablelist dl dt,
+ span.term
+ {
+ font-weight: bold;
+ font-size: 10pt;
+ }
+
+ div.variablelist table tbody tr td
+ {
+ text-align: left;
+ vertical-align: top;
+ padding: 0em 2em 0em 0em;
+ font-size: 10pt;
+ margin: 0em 0em 0.5em 0em;
+ line-height: 1;
+ }
+
+ /* Make the terms in definition lists bold */
+ div.variablelist dl dt
+ {
+ margin-bottom: 0.2em;
+ }
+
+ div.variablelist dl dd
+ {
+ margin: 0em 0em 0.5em 2em;
+ font-size: 10pt;
+ }
+
+ div.variablelist table tbody tr td p
+ div.variablelist dl dd p
+ {
+ margin: 0em 0em 0.5em 0em;
+ line-height: 1;
+ }
+
+/*=============================================================================
+ Misc
+=============================================================================*/
+
+ /* Title of books and articles in bibliographies */
+ span.title
+ {
+ font-style: italic;
+ }
+
+ span.underline
+ {
+ text-decoration: underline;
+ }
+
+ span.strikethrough
+ {
+ text-decoration: line-through;
+ }
+
+ /* Copyright, Legal Notice */
+ div div.legalnotice p
+ {
+ text-align: left
+ }
+
+/*=============================================================================
+ Colors
+=============================================================================*/
+
+ @media screen
+ {
+ /* Links */
+ a
+ {
+ color: #0C7445;
+ }
+
+ a:visited
+ {
+ color: #663974;
+ }
+
+ h1 a, h2 a, h3 a, h4 a, h5 a, h6 a,
+ h1 a:hover, h2 a:hover, h3 a:hover, h4 a:hover, h5 a:hover, h6 a:hover,
+ h1 a:visited, h2 a:visited, h3 a:visited, h4 a:visited, h5 a:visited, h6 a:visited
+ {
+ text-decoration: none; /* no underline */
+ color: #000000;
+ }
+
+ /* Syntax Highlighting */
+ .keyword { color: #0000AA; }
+ .identifier { color: #000000; }
+ .special { color: #707070; }
+ .preprocessor { color: #402080; }
+ .char { color: teal; }
+ .comment { color: #800000; }
+ .string { color: teal; }
+ .number { color: teal; }
+ .white_bkd { background-color: #E8FBE9; }
+ .dk_grey_bkd { background-color: #A0DAAC; }
+
+ /* Copyright, Legal Notice */
+ .copyright
+ {
+ color: #666666;
+ font-size: small;
+ }
+
+ div div.legalnotice p
+ {
+ color: #666666;
+ }
+
+ /* Program listing */
+ pre.synopsis
+ {
+ border: 1px solid #DCDCDC;
+ border-bottom: 3px solid #9D9D9D;
+ border-right: 3px solid #9D9D9D;
+ background-color: #FAFFFB;
+ }
+
+ .programlisting,
+ .screen
+ {
+ border: 1px solid #DCDCDC;
+ border-bottom: 3px solid #9D9D9D;
+ border-right: 3px solid #9D9D9D;
+ background-color: #FAFFFB;
+ }
+
+ td .programlisting,
+ td .screen
+ {
+ border: 0px solid #DCDCDC;
+ }
+
+ /* Blurbs */
+ div.note,
+ div.tip,
+ div.important,
+ div.caution,
+ div.warning,
+ div.sidebar
+ {
+ border: 1px solid #DCDCDC;
+ border-bottom: 3px solid #9D9D9D;
+ border-right: 3px solid #9D9D9D;
+ background-color: #FAFFFB;
+ }
+
+ /* Table of contents */
+ .toc
+ {
+ border: 1px solid #DCDCDC;
+ border-bottom: 3px solid #9D9D9D;
+ border-right: 3px solid #9D9D9D;
+ background-color: #FAFFFB;
+ }
+
+ /* Table of contents */
+ .toc-main
+ {
+ border: 1px solid #DCDCDC;
+ border-bottom: 3px solid #9D9D9D;
+ border-right: 3px solid #9D9D9D;
+ background-color: #FAFFFB;
+ }
+
+
+ /* Tables */
+ div.informaltable table tr td,
+ div.table table tr td
+ {
+ border: 1px solid #DCDCDC;
+ background-color: #FAFFFB;
+ }
+
+ div.informaltable table tr th,
+ div.table table tr th
+ {
+ background-color: #E3F9E4;
+ border: 1px solid #DCDCDC;
+ }
+
+ /* Misc */
+ span.highlight
+ {
+ color: #00A000;
+ }
+ }
+
+ @media print
+ {
+ /* Links */
+ a
+ {
+ color: black;
+ }
+
+ a:visited
+ {
+ color: black;
+ }
+
+ .spirit-nav
+ {
+ display: none;
+ }
+
+ /* Program listing */
+ pre.synopsis
+ {
+ border: 1px solid gray;
+ background-color: #FAFFFB;
+ }
+
+ .programlisting,
+ .screen
+ {
+ border: 1px solid gray;
+ background-color: #FAFFFB;
+ }
+
+ td .programlisting,
+ td .screen
+ {
+ border: 0px solid #DCDCDC;
+ }
+
+ /* Table of contents */
+ .toc
+ {
+ border: 1px solid #DCDCDC;
+ border-bottom: 3px solid #9D9D9D;
+ border-right: 3px solid #9D9D9D;
+ background-color: #FAFFFB;
+ }
+
+ /* Table of contents */
+ .toc-main
+ {
+ border: 1px solid #DCDCDC;
+ border-bottom: 3px solid #9D9D9D;
+ border-right: 3px solid #9D9D9D;
+ background-color: #FAFFFB;
+ }
+
+ .informaltable table,
+ .table table
+ {
+ border: 1px solid #DCDCDC;
+ border-bottom: 3px solid #9D9D9D;
+ border-right: 3px solid #9D9D9D;
+ border-collapse: collapse;
+ background-color: #FAFFFB;
+ }
+
+ /* Tables */
+ div.informaltable table tr td,
+ div.table table tr td
+ {
+ border: 1px solid #DCDCDC;
+ background-color: #FAFFFB;
+ }
+
+ div.informaltable table tr th,
+ div.table table tr th
+ {
+ border: 1px solid #DCDCDC;
+ background-color: #FAFFFB;
+ }
+
+ /* Misc */
+ span.highlight
+ {
+ font-weight: bold;
+ }
+ }
Added: sandbox/tokenmap/libs/tokenmap/doc/html/images/extern/googlesoc.png
==============================================================================
Binary file. No diff available.
Added: sandbox/tokenmap/libs/tokenmap/doc/html/images/people/slawomir.png
==============================================================================
Binary file. No diff available.
Added: sandbox/tokenmap/libs/tokenmap/doc/html/images/space.png
==============================================================================
Binary file. No diff available.
Added: sandbox/tokenmap/libs/tokenmap/doc/html/index.html
==============================================================================
--- (empty file)
+++ sandbox/tokenmap/libs/tokenmap/doc/html/index.html 2010-02-21 15:08:34 EST (Sun, 21 Feb 2010)
@@ -0,0 +1,76 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Chapter 1. Boost.Tokenmap</title>
+<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="index.html" title="Chapter 1. Boost.Tokenmap">
+<link rel="next" href="tokenmap/quick_tutorial.html" title="Quick tutorial">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav"><a accesskey="n" href="tokenmap/quick_tutorial.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a></div>
+<div class="chapter" lang="en">
+<div class="titlepage"><div>
+<div><h2 class="title">
+<a name="tokenmap"></a>Chapter 1. Boost.Tokenmap</h2></div>
+<div><div class="author"><h3 class="author">
+<span class="firstname">Slawomir</span> <span class="surname">Lisznianski</span>
+</h3></div></div>
+<div><p class="copyright">Copyright © 2009 Slawomir Lisznianski</p></div>
+<div><div class="legalnotice">
+<a name="id477452"></a><p>
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ </p>
+</div></div>
+</div></div>
+<div class="toc">
+<p><b>Table of Contents</b></p>
+<dl>
+<dt><span class="section">Description</span></dt>
+<dt><span class="section">Quick tutorial</span></dt>
+<dt><span class="section">Reference</span></dt>
+<dt><span class="section">Performance </span></dt>
+<dt><span class="section">Examples </span></dt>
+<dt><span class="section">Rationale </span></dt>
+<dt><span class="section">Future Work </span></dt>
+<dt><span class="section">Acknowledgements </span></dt>
+</dl>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="tokenmap.description"></a><a class="link" href="index.html#tokenmap.description" title="Description">Description</a>
+</h2></div></div></div>
+<p>
+ A <code class="computeroutput"><span class="identifier">tokenmap</span></code> is a data structure
+ that uniquely maps pseudo-random generated keys with elements of the collection.
+ </p>
+<p>
+ Boost.Tokenmap is a (perfect) hash container library for C++. An important
+ distinction between <code class="computeroutput"><span class="identifier">tokenmap</span></code>
+ and other dictionary-like containers, such as std::map or Boost.Unordered, is that <code class="computeroutput"><span class="identifier">tokenmap</span></code>
+ generates keys internally (referred to as "tokens") rather than relying
+ on user to provide them. Specifically, when a new element is inserted into
+ the <code class="computeroutput"><span class="identifier">tokenmap</span></code>, an apparently
+ random key is returned back to the caller which uniquely maps to the stored
+ element. The returned key can later be used for a very efficient lookup.
+ </p>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"><p><small>Last revised: February 21, 2010 at 19:46:48 GMT</small></p></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav"><a accesskey="n" href="tokenmap/quick_tutorial.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a></div>
+</body>
+</html>
Added: sandbox/tokenmap/libs/tokenmap/doc/html/standalone_HTML.manifest
==============================================================================
--- (empty file)
+++ sandbox/tokenmap/libs/tokenmap/doc/html/standalone_HTML.manifest 2010-02-21 15:08:34 EST (Sun, 21 Feb 2010)
@@ -0,0 +1,8 @@
+index.html
+tokenmap/quick_tutorial.html
+tokenmap/reference.html
+tokenmap/performance_.html
+tokenmap/examples_.html
+tokenmap/rationale_.html
+tokenmap/future_work_.html
+tokenmap/acknowledgements_.html
Added: sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/acknowledgements_.html
==============================================================================
--- (empty file)
+++ sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/acknowledgements_.html 2010-02-21 15:08:34 EST (Sun, 21 Feb 2010)
@@ -0,0 +1,40 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Acknowledgements</title>
+<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="../index.html" title="Chapter 1. Boost.Tokenmap">
+<link rel="up" href="../index.html" title="Chapter 1. Boost.Tokenmap">
+<link rel="prev" href="future_work_.html" title="Future Work">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="future_work_.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a>
+</div>
+<div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="tokenmap.acknowledgements_"></a><a class="link" href="acknowledgements_.html" title="Acknowledgements">Acknowledgements </a>
+</h2></div></div></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 © 2009 Slawomir Lisznianski<p>
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ </p>
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="future_work_.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
Added: sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/examples_.html
==============================================================================
--- (empty file)
+++ sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/examples_.html 2010-02-21 15:08:34 EST (Sun, 21 Feb 2010)
@@ -0,0 +1,41 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Examples</title>
+<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="../index.html" title="Chapter 1. Boost.Tokenmap">
+<link rel="up" href="../index.html" title="Chapter 1. Boost.Tokenmap">
+<link rel="prev" href="performance_.html" title="Performance">
+<link rel="next" href="rationale_.html" title="Rationale">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="performance_.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="rationale_.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="tokenmap.examples_"></a><a class="link" href="examples_.html" title="Examples">Examples </a>
+</h2></div></div></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 © 2009 Slawomir Lisznianski<p>
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ </p>
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="performance_.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="rationale_.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/future_work_.html
==============================================================================
--- (empty file)
+++ sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/future_work_.html 2010-02-21 15:08:34 EST (Sun, 21 Feb 2010)
@@ -0,0 +1,41 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Future Work</title>
+<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="../index.html" title="Chapter 1. Boost.Tokenmap">
+<link rel="up" href="../index.html" title="Chapter 1. Boost.Tokenmap">
+<link rel="prev" href="rationale_.html" title="Rationale">
+<link rel="next" href="acknowledgements_.html" title="Acknowledgements">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="rationale_.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="acknowledgements_.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="tokenmap.future_work_"></a><a class="link" href="future_work_.html" title="Future Work">Future Work </a>
+</h2></div></div></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 © 2009 Slawomir Lisznianski<p>
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ </p>
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="rationale_.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="acknowledgements_.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/performance_.html
==============================================================================
--- (empty file)
+++ sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/performance_.html 2010-02-21 15:08:34 EST (Sun, 21 Feb 2010)
@@ -0,0 +1,41 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Performance</title>
+<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="../index.html" title="Chapter 1. Boost.Tokenmap">
+<link rel="up" href="../index.html" title="Chapter 1. Boost.Tokenmap">
+<link rel="prev" href="reference.html" title="Reference">
+<link rel="next" href="examples_.html" title="Examples">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="reference.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="examples_.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="tokenmap.performance_"></a><a class="link" href="performance_.html" title="Performance">Performance </a>
+</h2></div></div></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 © 2009 Slawomir Lisznianski<p>
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ </p>
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="reference.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="examples_.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/quick_tutorial.html
==============================================================================
--- (empty file)
+++ sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/quick_tutorial.html 2010-02-21 15:08:34 EST (Sun, 21 Feb 2010)
@@ -0,0 +1,87 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Quick tutorial</title>
+<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="../index.html" title="Chapter 1. Boost.Tokenmap">
+<link rel="up" href="../index.html" title="Chapter 1. Boost.Tokenmap">
+<link rel="prev" href="../index.html" title="Chapter 1. Boost.Tokenmap">
+<link rel="next" href="reference.html" title="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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../index.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="reference.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="tokenmap.quick_tutorial"></a><a class="link" href="quick_tutorial.html" title="Quick tutorial">Quick tutorial</a>
+</h2></div></div></div>
+<p>
+ Start by including a convenience header avaiable in the boost directory:
+ </p>
+<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">tokenmap</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
+</pre>
+<p>
+ Next, we define a <code class="computeroutput"><span class="identifier">tokenmap</span></code>
+ for storing strings. The following code creates an empty <code class="computeroutput"><span class="identifier">tokenmap</span></code>
+ container with initial capacity set to 10000, load factor set to 0.7 and current
+ time as seed for pseudo-number generator:
+ </p>
+<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">tokenmap</span><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">></span> <span class="identifier">tokenmap_type</span><span class="special">;</span>
+<span class="identifier">tokenmap_type</span> <span class="identifier">names</span><span class="special">(</span> <span class="number">10000</span><span class="special">,</span> <span class="number">0.7</span><span class="special">,</span> <span class="identifier">time</span><span class="special">(</span><span class="identifier">NULL</span><span class="special">)</span> <span class="special">);</span>
+</pre>
+<p>
+ To insert elements into the container we do:
+ </p>
+<pre class="programlisting"><span class="identifier">tokenmap_type</span><span class="special">::</span><span class="identifier">value_type</span> <span class="identifier">rob</span> <span class="special">=</span>
+ <span class="identifier">names</span><span class="special">.</span><span class="identifier">insert</span><span class="special">(</span> <span class="string">"Robert DeNiro"</span> <span class="special">);</span>
+<span class="identifier">tokenmap_type</span><span class="special">::</span><span class="identifier">value_type</span> <span class="identifier">mart</span> <span class="special">=</span>
+ <span class="identifier">names</span><span class="special">.</span><span class="identifier">insert</span><span class="special">(</span> <span class="string">"Martin Scorsese"</span> <span class="special">);</span>
+</pre>
+<p>
+ The value returned from insert is a pair, defined as std::pair<unsigned
+ int, std::string*>. The first element of the pair is an auto-generated token,
+ whereas the second element is a pointer to the element that maps to it.
+ </p>
+<p>
+ With the returned token, we can perform efficient lookups on the container,
+ for example:
+ </p>
+<pre class="programlisting"><span class="identifier">tokenmap_type</span><span class="special">::</span><span class="identifier">mapped_type</span> <span class="special">*</span> <span class="identifier">name</span> <span class="special">=</span> <span class="identifier">names</span><span class="special">.</span><span class="identifier">find</span><span class="special">(</span> <span class="identifier">rob</span><span class="special">.</span><span class="identifier">first</span> <span class="special">);</span>
+</pre>
+<p>
+ We can also check if an element exists:
+ </p>
+<pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">found</span> <span class="special">=</span> <span class="identifier">names</span><span class="special">.</span><span class="identifier">exists</span><span class="special">(</span> <span class="identifier">rob</span><span class="special">.</span><span class="identifier">first</span> <span class="special">);</span>
+</pre>
+<p>
+ Finally, we can remove the element:
+ </p>
+<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">auto_ptr</span><span class="special"><</span><span class="identifier">map_type</span><span class="special">::</span><span class="identifier">mapped_type</span><span class="special">></span> <span class="identifier">take_over</span>
+ <span class="special">=</span> <span class="identifier">names</span><span class="special">.</span><span class="identifier">pop</span><span class="special">(</span> <span class="identifier">rob</span><span class="special">.</span><span class="identifier">first</span> <span class="special">);</span>
+</pre>
+</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 © 2009 Slawomir Lisznianski<p>
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ </p>
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../index.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="reference.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/rationale_.html
==============================================================================
--- (empty file)
+++ sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/rationale_.html 2010-02-21 15:08:34 EST (Sun, 21 Feb 2010)
@@ -0,0 +1,41 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Rationale</title>
+<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="../index.html" title="Chapter 1. Boost.Tokenmap">
+<link rel="up" href="../index.html" title="Chapter 1. Boost.Tokenmap">
+<link rel="prev" href="examples_.html" title="Examples">
+<link rel="next" href="future_work_.html" title="Future Work">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="examples_.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="future_work_.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="tokenmap.rationale_"></a><a class="link" href="rationale_.html" title="Rationale">Rationale </a>
+</h2></div></div></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 © 2009 Slawomir Lisznianski<p>
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ </p>
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="examples_.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="future_work_.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/reference.html
==============================================================================
--- (empty file)
+++ sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/reference.html 2010-02-21 15:08:34 EST (Sun, 21 Feb 2010)
@@ -0,0 +1,122 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Reference</title>
+<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="../index.html" title="Chapter 1. Boost.Tokenmap">
+<link rel="up" href="../index.html" title="Chapter 1. Boost.Tokenmap">
+<link rel="prev" href="quick_tutorial.html" title="Quick tutorial">
+<link rel="next" href="performance_.html" title="Performance">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="quick_tutorial.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="performance_.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="tokenmap.reference"></a><a class="link" href="reference.html" title="Reference">Reference</a>
+</h2></div></div></div>
+<a name="tokenmap.reference.headers"></a><h4>
+<a name="id486700"></a>
+ <a class="link" href="reference.html#tokenmap.reference.headers">Headers</a>
+ </h4>
+<p>
+ "boost/tokenmap.hpp" includes "boost/tokenmap/tokenmap.hpp"
+ and imports the <code class="computeroutput"><span class="identifier">tokenmap</span></code> class
+ to boost namespace.
+ </p>
+<a name="tokenmap.reference.synopsis"></a><h4>
+<a name="id486727"></a>
+ <a class="link" href="reference.html#tokenmap.reference.synopsis">Synopsis</a>
+ </h4>
+<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span>
+<span class="keyword">namespace</span> <span class="identifier">tokenmaps</span> <span class="special">{</span>
+
+<span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">value__</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">key__</span> <span class="special">=</span> <span class="identifier">uint32_t</span><span class="special">></span>
+<span class="keyword">class</span> <span class="identifier">tokenmap</span>
+<span class="special">{</span>
+ <span class="keyword">public</span><span class="special">:</span>
+
+ <span class="comment">// Metadata
+</span>
+ <span class="keyword">typedef</span> <span class="identifier">uint64_t</span> <span class="identifier">hash_type</span><span class="special">;</span>
+ <span class="keyword">typedef</span> <span class="identifier">key__</span> <span class="identifier">key_type</span><span class="special">;</span>
+ <span class="keyword">typedef</span> <span class="identifier">value__</span> <span class="identifier">mapped_type</span><span class="special">;</span>
+ <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="identifier">key_type</span><span class="special">,</span> <span class="identifier">mapped_type</span><span class="special">*></span> <span class="identifier">value_type</span><span class="special">;</span>
+
+ <span class="comment">// Constructor
+</span>
+ <span class="identifier">tokenmap</span><span class="special">(</span><span class="identifier">size_t</span> <span class="identifier">capacity</span><span class="special">,</span> <span class="keyword">float</span> <span class="identifier">load_factor</span><span class="special">,</span> <span class="identifier">hash_type</span> <span class="identifier">seed</span><span class="special">);</span>
+
+ <span class="comment">// Destructor
+</span>
+ <span class="special">~</span><span class="identifier">tokenmap</span><span class="special">();</span>
+
+ <span class="comment">// Modifiers
+</span>
+ <span class="identifier">value_type</span> <span class="identifier">insert</span><span class="special">(</span><span class="identifier">mapped_type</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">value</span><span class="special">);</span>
+
+ <span class="identifier">value_type</span> <span class="identifier">insert</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">auto_ptr</span><span class="special"><</span><span class="identifier">mapped_type</span><span class="special">></span> <span class="identifier">value</span><span class="special">);</span>
+
+ <span class="identifier">std</span><span class="special">::</span><span class="identifier">auto_ptr</span><span class="special"><</span><span class="identifier">mapped_type</span><span class="special">></span> <span class="identifier">pop</span><span class="special">(</span><span class="identifier">key_type</span> <span class="identifier">key</span><span class="special">);</span>
+
+ <span class="comment">// Accessors
+</span>
+ <span class="identifier">mapped_type</span> <span class="special">*</span> <span class="identifier">find</span><span class="special">(</span><span class="identifier">key_type</span> <span class="identifier">key</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+
+ <span class="keyword">bool</span> <span class="identifier">exists</span><span class="special">(</span><span class="identifier">key_type</span> <span class="identifier">key</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+
+ <span class="identifier">key_type</span> <span class="identifier">size</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span>
+<span class="special">};</span>
+
+<span class="special">}</span> <span class="comment">// namespace tokenmaps
+</span><span class="special">}</span> <span class="comment">// namespace boost
+</span></pre>
+<a name="tokenmap.reference.class_template_tokenmap"></a><h4>
+<a name="id487314"></a>
+ <a class="link" href="reference.html#tokenmap.reference.class_template_tokenmap">Class template tokenmap</a>
+ </h4>
+<a name="tokenmap.reference.nested_types"></a><h4>
+<a name="id487329"></a>
+ <a class="link" href="reference.html#tokenmap.reference.nested_types">Nested types</a>
+ </h4>
+<a name="tokenmap.reference.constructors__copy_and_assignment"></a><h4>
+<a name="id487343"></a>
+ <a class="link" href="reference.html#tokenmap.reference.constructors__copy_and_assignment">Constructors,
+ copy and assignment</a>
+ </h4>
+<pre class="programlisting"><span class="identifier">tokenmap</span><span class="special">(</span><span class="identifier">size_t</span> <span class="identifier">capacity</span><span class="special">,</span> <span class="keyword">float</span> <span class="identifier">load_factor</span><span class="special">,</span> <span class="identifier">hash_type</span> <span class="identifier">seed</span><span class="special">);</span>
+</pre>
+<div class="itemizedlist"><ul type="disc">
+<li>
+<span class="bold"><strong>Effects:</strong></span> Constructs an empty <code class="computeroutput"><span class="identifier">tokenmap</span></code>.
+ </li>
+<li>
+<span class="bold"><strong>Complexity:</strong></span> Constant.
+ </li>
+</ul></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 © 2009 Slawomir Lisznianski<p>
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ </p>
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="quick_tutorial.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="performance_.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/reference/class_template_tokenmap.html
==============================================================================
--- (empty file)
+++ sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/reference/class_template_tokenmap.html 2010-02-21 15:08:34 EST (Sun, 21 Feb 2010)
@@ -0,0 +1,42 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Class template tokenmap</title>
+<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="../../index.html" title="Chapter 1. Boost.Tokenmap">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="synopsis.html" title="Synopsis">
+<link rel="next" href="nested_types.html" title="Nested types">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="synopsis.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="nested_types.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title">
+<a name="tokenmap.reference.class_template_tokenmap"></a><a class="link" href="class_template_tokenmap.html" title="Class template tokenmap">Class template
+ tokenmap</a>
+</h3></div></div></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 © 2009 Slawomir Lisznianski<p>
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ </p>
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="synopsis.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="nested_types.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/reference/constructors__copy_and_assignment.html
==============================================================================
--- (empty file)
+++ sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/reference/constructors__copy_and_assignment.html 2010-02-21 15:08:34 EST (Sun, 21 Feb 2010)
@@ -0,0 +1,54 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Constructors, copy and assignment</title>
+<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="../../index.html" title="Chapter 1. Boost.Tokenmap">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="nested_types.html" title="Nested types">
+<link rel="next" href="../performance_.html" title="Performance">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="nested_types.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../performance_.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="tokenmap.reference.constructors__copy_and_assignment"></a><a class="link" href="constructors__copy_and_assignment.html" title="Constructors, copy and assignment">Constructors,
+ copy and assignment</a>
+</h3></div></div></div>
+<pre class="programlisting"><span class="identifier">tokenmap</span><span class="special">(</span><span class="identifier">size_t</span> <span class="identifier">capacity</span><span class="special">,</span> <span class="keyword">float</span> <span class="identifier">load_factor</span><span class="special">,</span> <span class="identifier">hash_type</span> <span class="identifier">seed</span><span class="special">);</span>
+</pre>
+<div class="itemizedlist"><ul type="disc">
+<li>
+<span class="bold"><strong>Effects:</strong></span> Constructs an empty <code class="computeroutput"><span class="identifier">tokenmap</span></code>.
+ </li>
+<li>
+<span class="bold"><strong>Complexity:</strong></span> Constant.
+ </li>
+</ul></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 © 2009 Slawomir Lisznianski<p>
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ </p>
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="nested_types.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../performance_.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/reference/header__boost_tokenmap_tokenmap_hpp__synopsis.html
==============================================================================
--- (empty file)
+++ sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/reference/header__boost_tokenmap_tokenmap_hpp__synopsis.html 2010-02-21 15:08:34 EST (Sun, 21 Feb 2010)
@@ -0,0 +1,87 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Header "boost/tokenmap/tokenmap.hpp" synopsis</title>
+<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="../../index.html" title="Chapter 1. Boost.Tokenmap">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="../reference.html" title="Reference">
+<link rel="next" href="class_template_tokenmap.html" title="Class template tokenmap">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../reference.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="class_template_tokenmap.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="tokenmap.reference.header__boost_tokenmap_tokenmap_hpp__synopsis"></a><a class="link" href="header__boost_tokenmap_tokenmap_hpp__synopsis.html" title='Header "boost/tokenmap/tokenmap.hpp" synopsis'>Header
+ "boost/tokenmap/tokenmap.hpp" synopsis</a>
+</h3></div></div></div>
+<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span>
+<span class="keyword">namespace</span> <span class="identifier">tokenmaps</span> <span class="special">{</span>
+
+<span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">value__</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">key__</span> <span class="special">=</span> <span class="identifier">uint32_t</span><span class="special">></span>
+<span class="keyword">class</span> <span class="identifier">tokenmap</span>
+<span class="special">{</span>
+ <span class="keyword">public</span><span class="special">:</span>
+
+ <span class="comment">// Metadata
+</span>
+ <span class="keyword">typedef</span> <span class="identifier">uint64_t</span> <span class="identifier">hash_type</span><span class="special">;</span>
+ <span class="keyword">typedef</span> <span class="identifier">key__</span> <span class="identifier">key_type</span><span class="special">;</span>
+ <span class="keyword">typedef</span> <span class="identifier">value__</span> <span class="identifier">mapped_type</span><span class="special">;</span>
+ <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="identifier">key_type</span><span class="special">,</span> <span class="identifier">mapped_type</span><span class="special">*></span> <span class="identifier">value_type</span><span class="special">;</span>
+
+ <span class="comment">// Constructor
+</span>
+ <span class="identifier">tokenmap</span><span class="special">(</span><span class="identifier">size_t</span> <span class="identifier">capacity</span><span class="special">,</span> <span class="keyword">float</span> <span class="identifier">load_factor</span><span class="special">,</span> <span class="identifier">hash_type</span> <span class="identifier">seed</span><span class="special">);</span>
+
+ <span class="comment">// Destructor
+</span>
+ <span class="special">~</span><span class="identifier">tokenmap</span><span class="special">();</span>
+
+ <span class="comment">// Modifiers
+</span>
+ <span class="identifier">value_type</span> <span class="identifier">insert</span><span class="special">(</span><span class="identifier">mapped_type</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">value</span><span class="special">);</span>
+
+ <span class="identifier">value_type</span> <span class="identifier">insert</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">auto_ptr</span><span class="special"><</span><span class="identifier">mapped_type</span><span class="special">></span> <span class="identifier">value</span><span class="special">);</span>
+
+ <span class="identifier">std</span><span class="special">::</span><span class="identifier">auto_ptr</span><span class="special"><</span><span class="identifier">mapped_type</span><span class="special">></span> <span class="identifier">pop</span><span class="special">(</span><span class="identifier">key_type</span> <span class="identifier">key</span><span class="special">);</span>
+
+ <span class="comment">// Accessors
+</span>
+ <span class="identifier">mapped_type</span> <span class="special">*</span> <span class="identifier">find</span><span class="special">(</span><span class="identifier">key_type</span> <span class="identifier">key</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+
+ <span class="keyword">bool</span> <span class="identifier">exists</span><span class="special">(</span><span class="identifier">key_type</span> <span class="identifier">key</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+
+ <span class="identifier">key_type</span> <span class="identifier">size</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span>
+<span class="special">};</span>
+
+<span class="special">}</span> <span class="comment">// namespace tokenmap
+</span><span class="special">}</span> <span class="comment">// namespace boost
+</span></pre>
+</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 © 2009 Slawomir Lisznianski<p>
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ </p>
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../reference.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="class_template_tokenmap.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/reference/nested_types.html
==============================================================================
--- (empty file)
+++ sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/reference/nested_types.html 2010-02-21 15:08:34 EST (Sun, 21 Feb 2010)
@@ -0,0 +1,41 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Nested types</title>
+<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="../../index.html" title="Chapter 1. Boost.Tokenmap">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="class_template_tokenmap.html" title="Class template tokenmap">
+<link rel="next" href="constructors__copy_and_assignment.html" title="Constructors, copy and assignment">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="class_template_tokenmap.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="constructors__copy_and_assignment.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title">
+<a name="tokenmap.reference.nested_types"></a><a class="link" href="nested_types.html" title="Nested types">Nested types</a>
+</h3></div></div></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 © 2009 Slawomir Lisznianski<p>
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ </p>
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="class_template_tokenmap.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="constructors__copy_and_assignment.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/reference/synopsis.html
==============================================================================
--- (empty file)
+++ sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/reference/synopsis.html 2010-02-21 15:08:34 EST (Sun, 21 Feb 2010)
@@ -0,0 +1,86 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Synopsis</title>
+<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
+<link rel="start" href="../../index.html" title="Chapter 1. Boost.Tokenmap">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="../reference.html" title="Reference">
+<link rel="next" href="class_template_tokenmap.html" title="Class template tokenmap">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../reference.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="class_template_tokenmap.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="tokenmap.reference.synopsis"></a><a class="link" href="synopsis.html" title="Synopsis">Synopsis</a>
+</h3></div></div></div>
+<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span>
+<span class="keyword">namespace</span> <span class="identifier">tokenmaps</span> <span class="special">{</span>
+
+<span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">value__</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">key__</span> <span class="special">=</span> <span class="identifier">uint32_t</span><span class="special">></span>
+<span class="keyword">class</span> <span class="identifier">tokenmap</span>
+<span class="special">{</span>
+ <span class="keyword">public</span><span class="special">:</span>
+
+ <span class="comment">// Metadata
+</span>
+ <span class="keyword">typedef</span> <span class="identifier">uint64_t</span> <span class="identifier">hash_type</span><span class="special">;</span>
+ <span class="keyword">typedef</span> <span class="identifier">key__</span> <span class="identifier">key_type</span><span class="special">;</span>
+ <span class="keyword">typedef</span> <span class="identifier">value__</span> <span class="identifier">mapped_type</span><span class="special">;</span>
+ <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="identifier">key_type</span><span class="special">,</span> <span class="identifier">mapped_type</span><span class="special">*></span> <span class="identifier">value_type</span><span class="special">;</span>
+
+ <span class="comment">// Constructor
+</span>
+ <span class="identifier">tokenmap</span><span class="special">(</span><span class="identifier">size_t</span> <span class="identifier">capacity</span><span class="special">,</span> <span class="keyword">float</span> <span class="identifier">load_factor</span><span class="special">,</span> <span class="identifier">hash_type</span> <span class="identifier">seed</span><span class="special">);</span>
+
+ <span class="comment">// Destructor
+</span>
+ <span class="special">~</span><span class="identifier">tokenmap</span><span class="special">();</span>
+
+ <span class="comment">// Modifiers
+</span>
+ <span class="identifier">value_type</span> <span class="identifier">insert</span><span class="special">(</span><span class="identifier">mapped_type</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">value</span><span class="special">);</span>
+
+ <span class="identifier">value_type</span> <span class="identifier">insert</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">auto_ptr</span><span class="special"><</span><span class="identifier">mapped_type</span><span class="special">></span> <span class="identifier">value</span><span class="special">);</span>
+
+ <span class="identifier">std</span><span class="special">::</span><span class="identifier">auto_ptr</span><span class="special"><</span><span class="identifier">mapped_type</span><span class="special">></span> <span class="identifier">pop</span><span class="special">(</span><span class="identifier">key_type</span> <span class="identifier">key</span><span class="special">);</span>
+
+ <span class="comment">// Accessors
+</span>
+ <span class="identifier">mapped_type</span> <span class="special">*</span> <span class="identifier">find</span><span class="special">(</span><span class="identifier">key_type</span> <span class="identifier">key</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+
+ <span class="keyword">bool</span> <span class="identifier">exists</span><span class="special">(</span><span class="identifier">key_type</span> <span class="identifier">key</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+
+ <span class="identifier">key_type</span> <span class="identifier">size</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span>
+<span class="special">};</span>
+
+<span class="special">}</span> <span class="comment">// namespace tokenmap
+</span><span class="special">}</span> <span class="comment">// namespace boost
+</span></pre>
+</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 © 2009 Slawomir Lisznianski<p>
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ </p>
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../reference.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="class_template_tokenmap.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Modified: sandbox/tokenmap/libs/tokenmap/doc/tokenmap.qbk
==============================================================================
--- sandbox/tokenmap/libs/tokenmap/doc/tokenmap.qbk (original)
+++ sandbox/tokenmap/libs/tokenmap/doc/tokenmap.qbk 2010-02-21 15:08:34 EST (Sun, 21 Feb 2010)
@@ -1,7 +1,11 @@
+[/ Copyright 2009 Slawomir Lisznianski
+ / Distributed under the Boost Software License, Version 1.0. (See accompanying
+ / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) ]
+
[library Boost.Tokenmap
[quickbook 1.4]
[authors [Lisznianski, Slawomir]]
- [copyright 2006-2007 Slawomir Lisznianski]
+ [copyright 2009 Slawomir Lisznianski]
[category container]
[id tokenmap]
[dirname tokenmap]
@@ -40,25 +44,7 @@
[/ Boost Libraries ]
-[def __BOOST_MULTI_INDEX__ [@http://www.boost.org/libs/multi_index/doc/index.html [*Boost.MultiIndex]]]
-[def __BOOST_MPL__ [@http://www.boost.org/libs/mpl/doc/index.html [*Boost.MPL]]]
-[def __BOOST_TYPE_TRAITS__ [@http://www.boost.org/doc/html/boost_typetraits.html [*Boost.TypeTraits]]]
-[def __BOOST_ENABLE_IF__ [@http://www.boost.org/libs/utility/enable_if.html [*Boost.enable_if]]]
-[def __BOOST_ITERATORS__ [@http://www.boost.org/libs/iterator/doc/index.html [*Boost.Iterators]]]
-[def __BOOST_CALL_TRAITS__ [@http://www.boost.org/libs/utility/call_traits.htm [*Boost.call_traits]]]
-[def __BOOST_STATIC_ASSERT__ [@http://www.boost.org/doc/html/boost_staticassert.html [*Boost.StaticAssert]]]
-
-[def __BOOST_SERIALIZATION__ [@http://www.boost.org/libs/serialization/doc/index.html [*Boost.Serialization]]]
-[def __BOOST_HASH__ [@http://www.boost.org/doc/html/hash.html [*Boost.Hash]]]
-[def __BOOST_ASSIGN__ [@http://www.boost.org/libs/assign/doc/index.html [*Boost.Assign]]]
-[def __BOOST_LAMBDA__ [@http://www.boost.org/doc/html/lambda.html [*Boost.Lambda]]]
-[def __BOOST_PROPERTY_MAP__ [@http://www.boost.org/doc/html/property_map.html [*Boost.PropertyMap]]]
-[def __BOOST_RANGE__ [@http://www.boost.org/doc/html/range.html [*Boost.Range]]]
-[def __BOOST_FOREACH__ [@http://www.boost.org/doc/html/foreach.html [*Boost.Foreach]]]
-[def __BOOST_TEST__ [@http://www.boost.org/libs/test/doc/index.html [*Boost.Test]]]
-[def __BOOST_TYPEOF__ [@http://www.boost.org/libs/typeof/doc/index.html [*Boost.Typeof]]]
-[def __BOOST_XPRESSIVE__ [@http://www.boost.org/libs/xpressive/doc/index.html [*Boost.Xpressive]]]
-
+[def _boost_unordered_ [@http://www.boost.org/libs/libs/unordered/doc/index.html [*Boost.Unordered]]]
[/ Extern Links ]
@@ -111,78 +97,67 @@
[import ../example/simple_tokenmap.cpp]
-[section Preface]
-
-[heading Description]
+[section Description]
-In summary, a tokenmap is a data structure that maps auto-generated tokens with
+A `tokenmap` is a data structure that uniquely maps pseudo-random generated keys with
elements of the collection.
-Boost.Tokenmap is a (perfect) hash container library for C++. The library provides
-a tokenmap, a data structure that maps auto-generated tokens with elements of
-the collection. An important distinction between tokenmap and other dictionary-like
-containers (such as std::map or boost::unordered) is that tokenmap generates the
-keys internally (referred to as "tokens") rather than relying on users to provide
-them. Specifically, when a new element is inserted into the tokenmap, an apparently
-random token is returned back to the caller. The returned token can later be used
-for very efficient lookups.
-
-[heading Influences and Related Work]
-
-The design of Boost.Tokenmap interface follows the standard template library.
+Boost.Tokenmap is a (perfect) hash container library for C++. An important distinction
+between `tokenmap` and other dictionary-like containers, such as std::map or
+_boost_unordered_, is that `tokenmap` generates keys internally (referred to as
+"tokens") rather than relying on user to provide them. Specifically, when a new element
+is inserted into the `tokenmap`, an apparently random key is returned back to the caller
+which uniquely maps to the stored element. The returned key can later be used for a very
+efficient lookup.
[endsect]
[section Quick tutorial]
-A convenience header is avaiable in the boost directory:
+Start by including a convenience header avaiable in the boost directory:
#include <boost/tokenmap.hpp>
-Lets define a token map for strings. The following code creates an empty tokenamp
+Next, we define a `tokenmap` for storing strings. The following code creates an empty `tokenmap`
container with initial capacity set to 10000, load factor set to 0.7 and current
time as seed for pseudo-number generator:
-typedef tokenmap<std::string, unsigned int> tokenmap_type;
-tokenmap_type names( 10000, 0.7, time(NULL) );
+ typedef boost::tokenmap<std::string, unsigned int> tokenmap_type;
+ tokenmap_type names( 10000, 0.7, time(NULL) );
-Next, to insert elements into the container we do:
+To insert elements into the container we do:
-tokenamp_type::value_type rob =
- names.insert( "Robert DeNiro" );
-tokenamp_type::value_type mart =
- names.insert( "Martin Scorsese" );
+ tokenmap_type::value_type rob =
+ names.insert( "Robert DeNiro" );
+ tokenmap_type::value_type mart =
+ names.insert( "Martin Scorsese" );
-The returned from insert `tokenamp_type::value_type' is a pair, defined as
-std::pair<unsigned int, std::string*>. The first element of the pair is an
-auto-generated token, whereas the second element is a pointer to the stored
-element that maps to it.
+The value returned from insert is a pair, defined as std::pair<unsigned int, std::string*>.
+The first element of the pair is an auto-generated token, whereas the second element
+is a pointer to the element that maps to it.
-With the returned token we can perform efficient lookups within the container,
-example:
+With the returned token, we can perform efficient lookups on the container, for example:
-tokenamp_type::mapped_type * name = names.find( rob.first );
+ tokenmap_type::mapped_type * name = names.find( rob.first );
We can also check if an element exists:
-bool found = names.exists( rob.first );
+ bool found = names.exists( rob.first );
Finally, we can remove the element:
-std::auto_ptr<map_type::mapped_type> take_over
- = names.pop( rob.first );
+ std::auto_ptr<map_type::mapped_type> take_over =
+ names.pop( rob.first );
[endsect]
[section Reference]
-[section Headers]
+[heading Headers]
-* "boost/tokenmap.hpp" ['(includes "boost/tokenmap/tokenmap.hpp" and imports the tokenmap class to boost namespace)]
+"boost/tokenmap.hpp" includes "boost/tokenmap/tokenmap.hpp" and imports the `tokenmap` class to boost namespace.
-[endsect]
-
-[section Header "boost/tokenmap/tokenmap.hpp" synopsis]
+[heading Synopsis]
namespace boost {
namespace tokenmaps {
@@ -224,18 +199,15 @@
key_type size() const;
};
- } // namespace tokenmap
+ } // namespace tokenmaps
} // namespace boost
-[endsect]
+[heading Class template tokenmap]
-[section Class template tokenmap]
-[endsect]
+[heading Nested types]
-[section Nested types]
-[endsect]
+[heading Constructors, copy and assignment]
-[section Constructors, copy and assignment]
tokenmap(size_t capacity, float load_factor, hash_type seed);
* [*Effects:] Constructs an empty `tokenmap`.
@@ -257,3 +229,4 @@
[section Acknowledgements ]
[endsect]
+
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk