|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r72598 - in sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html: . reference reference/hash
From: cpp.cabrera_at_[hidden]
Date: 2011-06-14 18:09:14
Author: alejandro
Date: 2011-06-14 18:09:13 EDT (Tue, 14 Jun 2011)
New Revision: 72598
URL: http://svn.boost.org/trac/boost/changeset/72598
Log:
Added all necessary documentation files to complete documentation. Added default page for files that don't have content yet. Ensured all navigation arrows go to correct place.
Added:
sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/acknowledgements.html
- copied, changed from r72595, /sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/misc.html
sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/history.html
- copied, changed from r72595, /sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/misc.html
sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/reference/
sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/reference/bloom.html (contents, props changed)
sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/reference/hash/
sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/reference/hash/default.html (contents, props changed)
sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/testing.html
- copied, changed from r72595, /sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/misc.html
Text files modified:
sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/acknowledgements.html | 10 ++--------
sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/bibliography.html | 12 +++++++++---
sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/design.html | 15 +++++++++------
sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/history.html | 10 +++++-----
sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/index.html | 2 +-
sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/misc.html | 6 +++---
sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/reference.html | 14 +++++---------
sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/testing.html | 12 ++++++------
sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/tutorial.html | 4 ++--
9 files changed, 42 insertions(+), 43 deletions(-)
Copied: sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/acknowledgements.html (from r72595, /sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/misc.html)
==============================================================================
--- /sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/misc.html (original)
+++ sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/acknowledgements.html 2011-06-14 18:09:13 EDT (Tue, 14 Jun 2011)
@@ -30,12 +30,9 @@
<a accesskey="h" href="index.html">
<img src="../../../../doc/src/images/home.png" alt="Home"/>
</a>
- <a accesskey="n" href="reference.html">
- <img src="../../../../doc/src/images/next.png" alt="Next"/>
- </a>
</div>
- <h2 class="title">Miscellaneous</h2>
+ <h1 class="title">To be completed...</h1>
<hr/>
<div class="spirit-nav">
@@ -45,14 +42,11 @@
<a accesskey="h" href="index.html">
<img src="../../../../doc/src/images/home.png" alt="Home"/>
</a>
- <a accesskey="n" href="reference.html">
- <img src="../../../../doc/src/images/next.png" alt="Next"/>
- </a>
</div>
<footer>
<p>
- Last revised: <time datetime="2011-06-06">June 6, 2011</time>.
+ Last revised: <time datetime="2011-06-14">June 14, 2011</time>.
</p>
<p class="copyright">
Modified: sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/bibliography.html
==============================================================================
--- sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/bibliography.html (original)
+++ sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/bibliography.html 2011-06-14 18:09:13 EDT (Tue, 14 Jun 2011)
@@ -24,12 +24,15 @@
<hr/>
<div class="spirit-nav">
- <a accesskey="p" href="reference.html">
+ <a accesskey="p" href="testing.html">
<img src="../../../../doc/src/images/prev.png" alt="Prev"/>
</a>
<a accesskey="h" href="index.html">
<img src="../../../../doc/src/images/home.png" alt="Home"/>
</a>
+ <a accesskey="n" href="history.html">
+ <img src="../../../../doc/src/images/next.png" alt="Next"/>
+ </a>
</div>
<h2 class="title">Bibliography</h2>
@@ -75,17 +78,20 @@
<hr/>
<div class="spirit-nav">
- <a accesskey="p" href="reference.html">
+ <a accesskey="p" href="testing.html">
<img src="../../../../doc/src/images/prev.png" alt="Prev"/>
</a>
<a accesskey="h" href="index.html">
<img src="../../../../doc/src/images/home.png" alt="Home"/>
</a>
+ <a accesskey="n" href="history.html">
+ <img src="../../../../doc/src/images/next.png" alt="Next"/>
+ </a>
</div>
<footer>
<p>
- Last revised: <time datetime="2011-06-06">June 6, 2011</time>.
+ Last revised: <time datetime="2011-06-14">June 14, 2011</time>.
</p>
<p class="copyright">
Modified: sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/design.html
==============================================================================
--- sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/design.html (original)
+++ sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/design.html 2011-06-14 18:09:13 EDT (Tue, 14 Jun 2011)
@@ -24,13 +24,13 @@
<hr/>
<div class="spirit-nav">
- <a accesskey="p" href="tutorial.html">
+ <a accesskey="p" href="history.html">
<img src="../../../../doc/src/images/prev.png" alt="Prev"/>
</a>
<a accesskey="h" href="index.html">
<img src="../../../../doc/src/images/home.png" alt="Home"/>
</a>
- <a accesskey="n" href="misc.html">
+ <a accesskey="n" href="acknowledgements.html">
<img src="../../../../doc/src/images/next.png" alt="Next"/>
</a>
</div>
@@ -77,8 +77,11 @@
To make the Bloom filter easy to use, the HashFunctions template partameter has a default value. This way, if the user wishes to use a Bloom filter for a quick, non-critical task, the user has the ability to just declare and use.
</p>
<p>
- The default hash function set consists of three boost_hash function objects seeded with the values 3, 5, and 7. These are implemented using Boost.Functional hash_range. The boost_hash function object is made available in the file boost/bloom_filter/hash/default.hpp for users that wish to use more or fewer hash functions to use their Bloom filter without having to create their own hash function object.
+ The default hash function set consists of three boost_hash function objects. These are implemented by computing Boost.Functional hash_value and incrementing the result by the seed. The boost_hash function object is made available in the file boost/bloom_filter/hash/default.hpp for users that wish to use more or fewer hash functions to use their Bloom filter without having to create their own hash function object.
</p>
+ <div class="warning">
+ <strong>Be warned</strong> - the Boost default hash function when hashing integral types returns the unsigned version of the integer itself. This makes it such that using the default Bloom filter works against you. In this case, it's best to use a single boost_hash function object with seed set to 0.
+ </div>
<h4>C++0x Considerations</h4>
<a name="c++0x"></a>
@@ -134,20 +137,20 @@
</p>
<hr/>
<div class="spirit-nav">
- <a accesskey="p" href="tutorial.html">
+ <a accesskey="p" href="history.html">
<img src="../../../../doc/src/images/prev.png" alt="Prev"/>
</a>
<a accesskey="h" href="index.html">
<img src="../../../../doc/src/images/home.png" alt="Home"/>
</a>
- <a accesskey="n" href="misc.html">
+ <a accesskey="n" href="acknowledgements.html">
<img src="../../../../doc/src/images/next.png" alt="Next"/>
</a>
</div>
<footer>
<p>
- Last revised: <time datetime="2011-06-13">June 13, 2011</time>.
+ Last revised: <time datetime="2011-06-14">June 14, 2011</time>.
</p>
<p class="copyright">
Copied: sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/history.html (from r72595, /sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/misc.html)
==============================================================================
--- /sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/misc.html (original)
+++ sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/history.html 2011-06-14 18:09:13 EDT (Tue, 14 Jun 2011)
@@ -24,28 +24,28 @@
<hr/>
<div class="spirit-nav">
- <a accesskey="p" href="design.html">
+ <a accesskey="p" href="bibliography.html">
<img src="../../../../doc/src/images/prev.png" alt="Prev"/>
</a>
<a accesskey="h" href="index.html">
<img src="../../../../doc/src/images/home.png" alt="Home"/>
</a>
- <a accesskey="n" href="reference.html">
+ <a accesskey="n" href="design.html">
<img src="../../../../doc/src/images/next.png" alt="Next"/>
</a>
</div>
- <h2 class="title">Miscellaneous</h2>
+ <h1 class="title">To be completed...</h1>
<hr/>
<div class="spirit-nav">
- <a accesskey="p" href="design.html">
+ <a accesskey="p" href="bibliography.html">
<img src="../../../../doc/src/images/prev.png" alt="Prev"/>
</a>
<a accesskey="h" href="index.html">
<img src="../../../../doc/src/images/home.png" alt="Home"/>
</a>
- <a accesskey="n" href="reference.html">
+ <a accesskey="n" href="design.html">
<img src="../../../../doc/src/images/next.png" alt="Next"/>
</a>
</div>
Modified: sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/index.html
==============================================================================
--- sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/index.html (original)
+++ sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/index.html 2011-06-14 18:09:13 EDT (Tue, 14 Jun 2011)
@@ -73,7 +73,7 @@
<footer>
<p>
- Last revised: <time datetime="2011-06-06">June 6, 2011</time>.
+ Last revised: <time datetime="2011-06-14">June 14, 2011</time>.
</p>
<p class="copyright">
Modified: sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/misc.html
==============================================================================
--- sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/misc.html (original)
+++ sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/misc.html 2011-06-14 18:09:13 EDT (Tue, 14 Jun 2011)
@@ -24,7 +24,7 @@
<hr/>
<div class="spirit-nav">
- <a accesskey="p" href="design.html">
+ <a accesskey="p" href="tutorial.html">
<img src="../../../../doc/src/images/prev.png" alt="Prev"/>
</a>
<a accesskey="h" href="index.html">
@@ -39,7 +39,7 @@
<hr/>
<div class="spirit-nav">
- <a accesskey="p" href="design.html">
+ <a accesskey="p" href="tutorial.html">
<img src="../../../../doc/src/images/prev.png" alt="Prev"/>
</a>
<a accesskey="h" href="index.html">
@@ -52,7 +52,7 @@
<footer>
<p>
- Last revised: <time datetime="2011-06-06">June 6, 2011</time>.
+ Last revised: <time datetime="2011-06-14">June 14, 2011</time>.
</p>
<p class="copyright">
Modified: sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/reference.html
==============================================================================
--- sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/reference.html (original)
+++ sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/reference.html 2011-06-14 18:09:13 EDT (Tue, 14 Jun 2011)
@@ -30,7 +30,7 @@
<a accesskey="h" href="index.html">
<img src="../../../../doc/src/images/home.png" alt="Home"/>
</a>
- <a accesskey="n" href="bibliography.html">
+ <a accesskey="n" href="reference/bloom.html">
<img src="../../../../doc/src/images/next.png" alt="Next"/>
</a>
</div>
@@ -39,12 +39,8 @@
<div class="toc">
<ul>
- <li><a href="reference/bloom_hpp.html">
- boost/bloom_filter/bloom.hpp</a></li>
- <li><a href="reference/hash/defaul_hpp.html">
- boost/bloom_filter/hash/default.hpp</a></li>
- <li><a href="reference/detail/apply_hash_hpp.html">
- boost/bloom_filter/detail/apply_hash.hpp</a></li>
+ <li>class bloom_filter</li>
+ <li>boost_hash (default hasher)</li>
</ul>
</div>
@@ -56,14 +52,14 @@
<a accesskey="h" href="index.html">
<img src="../../../../doc/src/images/home.png" alt="Home"/>
</a>
- <a accesskey="n" href="bibliography.html">
+ <a accesskey="n" href="reference/bloom.html">
<img src="../../../../doc/src/images/next.png" alt="Next"/>
</a>
</div>
<footer>
<p>
- Last revised: <time datetime="2011-06-06">June 6, 2011</time>.
+ Last revised: <time datetime="2011-06-14">June 14, 2011</time>.
</p>
<p class="copyright">
Added: sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/reference/bloom.html
==============================================================================
--- (empty file)
+++ sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/reference/bloom.html 2011-06-14 18:09:13 EDT (Tue, 14 Jun 2011)
@@ -0,0 +1,79 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
+ <link rel="stylesheet" type="text/css"
+ href="../../../../../doc/src/boostbook.css"/>
+ <link rel="stylesheet" type="text/css" href="style/my.css"/>
+
+ <title>Boost.BloomFilter</title>
+ </head>
+
+ <body>
+ <header>
+ <img src="../../../../../boost.png" width="277" height="86"
+ alt="Boost C++ Libraries"/>
+ <p>
+ Home
+ Libraries
+ People
+ FAQ
+ More
+ </p>
+ </header>
+
+ <hr/>
+ <div class="spirit-nav">
+ <a accesskey="p" href="../reference.html">
+ <img src="../../../../../doc/src/images/prev.png" alt="Prev"/>
+ </a>
+ <a accesskey="u" href="../reference.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="hash/default.html">
+ <img src="../../../../../doc/src/images/next.png" alt="Next"/>
+ </a>
+ </div>
+
+ <h1 class="title">To be completed...</h1>
+
+ <hr/>
+ <div class="spirit-nav">
+ <a accesskey="p" href="../reference.html">
+ <img src="../../../../../doc/src/images/prev.png" alt="Prev"/>
+ </a>
+ <a accesskey="u" href="../reference.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="hash/default.html">
+ <img src="../../../../../doc/src/images/next.png" alt="Next"/>
+ </a>
+ </div>
+
+ <footer>
+ <p>
+ Last revised: <time datetime="2011-06-14">June 14, 2011</time>.
+ </p>
+
+ <p class="copyright">
+ Copyright © 2011
+ <a href="mailto:cpp.cabrera_at_[hidden]">Alejandro Cabrera</a>
+ </p>
+
+ <p class="copyright">
+ 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>
+ </footer>
+
+ </body>
+</html>
Added: sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/reference/hash/default.html
==============================================================================
--- (empty file)
+++ sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/reference/hash/default.html 2011-06-14 18:09:13 EDT (Tue, 14 Jun 2011)
@@ -0,0 +1,79 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
+ <link rel="stylesheet" type="text/css"
+ href="../../../../../../doc/src/boostbook.css"/>
+ <link rel="stylesheet" type="text/css" href="style/my.css"/>
+
+ <title>Boost.BloomFilter</title>
+ </head>
+
+ <body>
+ <header>
+ <img src="../../../../../../boost.png" width="277" height="86"
+ alt="Boost C++ Libraries"/>
+ <p>
+ Home
+ Libraries
+ People
+ FAQ
+ More
+ </p>
+ </header>
+
+ <hr/>
+ <div class="spirit-nav">
+ <a accesskey="p" href="../bloom.html">
+ <img src="../../../../../../doc/src/images/prev.png" alt="Prev"/>
+ </a>
+ <a accesskey="u" href="../../reference.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="../../testing.html">
+ <img src="../../../../../../doc/src/images/next.png" alt="Next"/>
+ </a>
+ </div>
+
+ <h1 class="title">To be completed...</h1>
+
+ <hr/>
+ <div class="spirit-nav">
+ <a accesskey="p" href="../bloom.html">
+ <img src="../../../../../../doc/src/images/prev.png" alt="Prev"/>
+ </a>
+ <a accesskey="u" href="../../reference.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="../../testing.html">
+ <img src="../../../../../../doc/src/images/next.png" alt="Next"/>
+ </a>
+ </div>
+
+ <footer>
+ <p>
+ Last revised: <time datetime="2011-06-14">June 14, 2011</time>.
+ </p>
+
+ <p class="copyright">
+ Copyright © 2011
+ <a href="mailto:cpp.cabrera_at_[hidden]">Alejandro Cabrera</a>
+ </p>
+
+ <p class="copyright">
+ 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>
+ </footer>
+
+ </body>
+</html>
Copied: sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/testing.html (from r72595, /sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/misc.html)
==============================================================================
--- /sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/misc.html (original)
+++ sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/testing.html 2011-06-14 18:09:13 EDT (Tue, 14 Jun 2011)
@@ -24,35 +24,35 @@
<hr/>
<div class="spirit-nav">
- <a accesskey="p" href="design.html">
+ <a accesskey="p" href="reference/hash/default.html">
<img src="../../../../doc/src/images/prev.png" alt="Prev"/>
</a>
<a accesskey="h" href="index.html">
<img src="../../../../doc/src/images/home.png" alt="Home"/>
</a>
- <a accesskey="n" href="reference.html">
+ <a accesskey="n" href="bibliography.html">
<img src="../../../../doc/src/images/next.png" alt="Next"/>
</a>
</div>
- <h2 class="title">Miscellaneous</h2>
+ <h1 class="title">To be completed...</h1>
<hr/>
<div class="spirit-nav">
- <a accesskey="p" href="design.html">
+ <a accesskey="p" href="reference/hash/default.html">
<img src="../../../../doc/src/images/prev.png" alt="Prev"/>
</a>
<a accesskey="h" href="index.html">
<img src="../../../../doc/src/images/home.png" alt="Home"/>
</a>
- <a accesskey="n" href="reference.html">
+ <a accesskey="n" href="bibliography.html">
<img src="../../../../doc/src/images/next.png" alt="Next"/>
</a>
</div>
<footer>
<p>
- Last revised: <time datetime="2011-06-06">June 6, 2011</time>.
+ Last revised: <time datetime="2011-06-14">June 14, 2011</time>.
</p>
<p class="copyright">
Modified: sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/tutorial.html
==============================================================================
--- sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/tutorial.html (original)
+++ sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/tutorial.html 2011-06-14 18:09:13 EDT (Tue, 14 Jun 2011)
@@ -30,7 +30,7 @@
<a accesskey="h" href="index.html">
<img src="../../../../doc/src/images/home.png" alt="Home"/>
</a>
- <a accesskey="n" href="design.html">
+ <a accesskey="n" href="misc.html">
<img src="../../../../doc/src/images/next.png" alt="Next"/>
</a>
</div>
@@ -211,7 +211,7 @@
<a accesskey="h" href="index.html">
<img src="../../../../doc/src/images/home.png" alt="Home"/>
</a>
- <a accesskey="n" href="design.html">
+ <a accesskey="n" href="misc.html">
<img src="../../../../doc/src/images/next.png" alt="Next"/>
</a>
</div>
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