Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r61242 - in sandbox/tokenmap/libs/tokenmap/doc: . html html/tokenmap
From: sl_at_[hidden]
Date: 2010-04-13 08:56:09


Author: sl_
Date: 2010-04-13 08:56:07 EDT (Tue, 13 Apr 2010)
New Revision: 61242
URL: http://svn.boost.org/trac/boost/changeset/61242

Log:
doc tweaks
Text files modified:
   sandbox/tokenmap/libs/tokenmap/doc/html/index.html | 15 ++++++++-------
   sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/background.html | 6 +++---
   sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/examples_.html | 2 +-
   sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/reference.html | 10 +++++-----
   sandbox/tokenmap/libs/tokenmap/doc/tokenmap.qbk | 4 ++--
   5 files changed, 19 insertions(+), 18 deletions(-)

Modified: sandbox/tokenmap/libs/tokenmap/doc/html/index.html
==============================================================================
--- sandbox/tokenmap/libs/tokenmap/doc/html/index.html (original)
+++ sandbox/tokenmap/libs/tokenmap/doc/html/index.html 2010-04-13 08:56:07 EDT (Tue, 13 Apr 2010)
@@ -27,7 +27,7 @@
 </h3></div></div>
 <div><p class="copyright">Copyright &#169; 2009 Slawomir Lisznianski</p></div>
 <div><div class="legalnotice">
-<a name="id501064"></a><p>
+<a name="id554005"></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>
@@ -54,14 +54,15 @@
 </h2></div></div></div>
 <p>
       A <code class="computeroutput"><span class="identifier">tokenmap</span></code> is a data structure
- that uniquely maps internally generated integer keys to values.
+ that uniquely maps integer keys (called <code class="computeroutput"><span class="identifier">tokens</span></code>)
+ with values.
     </p>
 <p>
       Unlike typical dictionary-like containers such as <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">map</span></code> or
- <code class="computeroutput"><span class="identifier">boost_unordered</span></code>, a <code class="computeroutput"><span class="identifier">tokenmap</span></code> generates keys internally (called
- <code class="computeroutput"><span class="identifier">tokens</span></code>) for stored values.
- The keys are pseudo-random in appearance yet have the property of allowing
- the container a very efficient look-up, in the order of indexing within a C-array.
+ <code class="computeroutput"><span class="identifier">boost_unordered</span></code>, <code class="computeroutput"><span class="identifier">tokenmap</span></code> generates the keys internally for
+ stored values. The keys are pseudo-random in appearance yet have the property
+ of allowing the container a very efficient look-up, in the order of indexing
+ within a C-array.
     </p>
 <p>
       <code class="literal">tokenmap</code>s have the following properties:
@@ -88,7 +89,7 @@
 </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: April 13, 2010 at 12:53:00 GMT</small></p></td>
+<td align="left"><p><small>Last revised: April 13, 2010 at 12:55:44 GMT</small></p></td>
 <td align="right"><div class="copyright-footer"></div></td>
 </tr></table>
 <hr>

Modified: sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/background.html
==============================================================================
--- sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/background.html (original)
+++ sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/background.html 2010-04-13 08:56:07 EDT (Tue, 13 Apr 2010)
@@ -139,7 +139,7 @@
         hashing property is preserved.
       </p>
 <a name="tokenmap.background.analysis_of_simple_strategy.modular_arithmetic_notation"></a><h5>
-<a name="id510281"></a>
+<a name="id563221"></a>
         <a class="link" href="background.html#tokenmap.background.analysis_of_simple_strategy.modular_arithmetic_notation">Modular
         arithmetic notation</a>
       </h5>
@@ -153,7 +153,7 @@
         the set of all integers that are congruent modulo <span class="emphasis"><em>s</em></span>.
       </p>
 <a name="tokenmap.background.analysis_of_simple_strategy.proposition_1__perfect_hashing_is_preserved_with_multiples_of_the_old_store_length"></a><h5>
-<a name="id510364"></a>
+<a name="id563304"></a>
         <a class="link" href="background.html#tokenmap.background.analysis_of_simple_strategy.proposition_1__perfect_hashing_is_preserved_with_multiples_of_the_old_store_length">Proposition
         1: Perfect hashing is preserved with multiples of the old store length</a>
       </h5>
@@ -212,7 +212,7 @@
         so [<span class="emphasis"><em>x</em></span>]<sub><span class="emphasis"><em>s</em></span><sub><span class="emphasis"><em>k</em></span></sub></sub> equals [<span class="emphasis"><em>y</em></span>]<sub><span class="emphasis"><em>s</em></span><sub><span class="emphasis"><em>k</em></span></sub></sub>. &#8718;
       </p>
 <a name="tokenmap.background.analysis_of_simple_strategy.__emphasis_s__emphasis_____quickbook_escape_prefix____subscript__emphasis_k__emphasis___subscript_____quickbook_escape_postfix_____that_preserves_perfect_hashing_after_arbitrary_rehashes"></a><h5>
-<a name="id510634"></a>
+<a name="id563574"></a>
         <a class="link" href="background.html#tokenmap.background.analysis_of_simple_strategy.__emphasis_s__emphasis_____quickbook_escape_prefix____subscript__emphasis_k__emphasis___subscript_____quickbook_escape_postfix_____that_preserves_perfect_hashing_after_arbitrary_rehashes">{<span class="emphasis"><em>s</em></span><sub><span class="emphasis"><em>k</em></span></sub>}
         that preserves perfect hashing after arbitrary rehashes</a>
       </h5>

Modified: sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/examples_.html
==============================================================================
--- sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/examples_.html (original)
+++ sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/examples_.html 2010-04-13 08:56:07 EDT (Tue, 13 Apr 2010)
@@ -32,7 +32,7 @@
       them:
     </p>
 <div class="table">
-<a name="id512303"></a><p class="title"><b>Table&#160;1.1.&#160;Tutorial examples</b></p>
+<a name="id565244"></a><p class="title"><b>Table&#160;1.1.&#160;Tutorial examples</b></p>
 <div class="table-contents"><table class="table" summary="Tutorial examples">
 <colgroup>
 <col>

Modified: sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/reference.html
==============================================================================
--- sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/reference.html (original)
+++ sandbox/tokenmap/libs/tokenmap/doc/html/tokenmap/reference.html 2010-04-13 08:56:07 EDT (Tue, 13 Apr 2010)
@@ -27,7 +27,7 @@
 <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="id511297"></a>
+<a name="id564239"></a>
       <a class="link" href="reference.html#tokenmap.reference.headers">Headers</a>
     </h4>
 <p>
@@ -36,7 +36,7 @@
       to boost namespace.
     </p>
 <a name="tokenmap.reference.synopsis"></a><h4>
-<a name="id511324"></a>
+<a name="id564266"></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>
@@ -83,15 +83,15 @@
 </span><span class="special">}</span> <span class="comment">// namespace boost
 </span></pre>
 <a name="tokenmap.reference.class_template_tokenmap"></a><h4>
-<a name="id511912"></a>
+<a name="id564853"></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="id511926"></a>
+<a name="id564867"></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="id511941"></a>
+<a name="id564882"></a>
       <a class="link" href="reference.html#tokenmap.reference.constructors__copy_and_assignment">Constructors,
       copy and assignment</a>
     </h4>

Modified: sandbox/tokenmap/libs/tokenmap/doc/tokenmap.qbk
==============================================================================
--- sandbox/tokenmap/libs/tokenmap/doc/tokenmap.qbk (original)
+++ sandbox/tokenmap/libs/tokenmap/doc/tokenmap.qbk 2010-04-13 08:56:07 EDT (Tue, 13 Apr 2010)
@@ -99,9 +99,9 @@
 
 [section Description]
 
-A `tokenmap` is a data structure that uniquely maps internally generated integer keys to values.
+A `tokenmap` is a data structure that uniquely maps integer keys (called `tokens`) with values.
 
-Unlike typical dictionary-like containers such as `std::map` or `boost_unordered`, a `tokenmap` generates keys internally (called `tokens`) for stored values. The keys are pseudo-random in appearance yet have the property of allowing the container a very efficient look-up, in the order of indexing within a C-array.
+Unlike typical dictionary-like containers such as `std::map` or `boost_unordered`, `tokenmap` generates the keys internally for stored values. The keys are pseudo-random in appearance yet have the property of allowing the container a very efficient look-up, in the order of indexing within a C-array.
 
 [^tokenmap]s have the following properties:
 


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