Boost logo

Boost-Commit :

Date view Thread view Subject view Author view

Subject: [Boost-commit] svn:boost r72615 - in sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html: . reference style
From: cpp.cabrera_at_[hidden]
Date: 2011-06-16 15:29:40

Author: alejandro
Date: 2011-06-16 15:29:38 EDT (Thu, 16 Jun 2011)
New Revision: 72615
URL: http://svn.boost.org/trac/boost/changeset/72615

Log:
Produced syntax-highlighted version of bloom_filter class. Still need to fill in function reference. Completed testing documentation.
Added:
   sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/testing.html (contents, props changed)
Text files modified:
   sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/reference/bloom.html | 68 ++++++++++++++++++++++++++++++++++++++-
   sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/style/my.css | 6 +-
   2 files changed, 68 insertions(+), 6 deletions(-)

Modified: sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/reference/bloom.html
==============================================================================
--- sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/reference/bloom.html (original)
+++ sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/reference/bloom.html 2011-06-16 15:29:38 EDT (Thu, 16 Jun 2011)
@@ -4,7 +4,7 @@
     <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"/>
+ <link rel="stylesheet" type="text/css" href="../style/my.css"/>
 
     <title>Boost.BloomFilter</title>
   </head>
@@ -38,7 +38,69 @@
       </a>
     </div>
 
- <h1 class="title">To be completed...</h1>
+ <h1>Basic Bloom Filter</h1>
+ <div class="listing">
+ <code class="c_keyword">template</code> &lt;<code class="c_keyword">typename</code> <code class="c_id">T</code>,
+ <code class="c_type">size_t</code> <code class="c_id">Size</code>,
+ <code class="c_keyword">class</code> <code class="c_id">HashFunctions</code> = <code class="c_namespace">mpl::vector</code>&lt;<code class="c_type">boost_hash</code>&lt;<code class="c_id">T, 3</code>&gt;,
+ <code class="c_type">boost_hash</code>&lt;<code class="c_id">T, 37</code>&gt; &gt; &gt;
+ <code class="c_keyword">class</code> <code class="c_id">bloom_filter</code> {
+ <code class="c_comment">// exported typedefs</code>
+ <code class="c_keyword">typedef</code> <code class="c_id">T value_type</code>;
+ <code class="c_keyword">typedef</code> <code class="c_id">T key_type</code>;
+
+ <code class="c_comment">// constructors</code>
+ <code class="c_func">bloom_filter</code>();
+
+ <code class="c_comment">// data structure metadata query functions</code>
+ <code class="c_keyword">static constexpr</code> <code class="c_type">size_t</code> <code class="c_func">size</code>() <code class="c_keyword">const</code>;
+ <code class="c_keyword">static constexpr</code> <code class="c_type">size_t</code> <code class="c_func">num_hash_functions</code>() <code class="c_keyword">const</code>;
+ <code class="c_type">double</code> <code class="c_func">false_positive_rate</code>() <code class="c_keyword">const</code>;
+ <code class="c_type">size_t</code> <code class="c_func">count</code>() <code class="c_keyword">const</code>;
+
+ <code class="c_comment">// data structures core ops</code>
+ <code class="c_type">void</code> <code class="c_func">insert</code>(<code class="c_keyword">const</code> <code class="c_type">T</code>&amp;);
+ <code class="c_type">bool</code> <code class="c_func">contains</code>(<code class="c_keyword">const</code> <code class="c_type">T</code>&amp;) <code class="c_keyword">const</code>;
+
+ <code class="c_comment">// union assign/intersect assign</code>
+ <code class="c_type">bloom_filter</code>&amp; <code class="c_func">operator|=</code>(<code class="c_keyword">const</code> <code class="c_type">bloom_filter</code>&amp;);
+ <code class="c_type">bloom_filter</code>&amp; <code class="c_func">operator&amp;=</code>(<code class="c_keyword">const</code> <code class="c_type">bloom_filter</code>&amp;);
+ };
+
+ <code class="c_comment">// union</code>
+ <code class="c_keyword">template</code> &lt;<code class="c_keyword">typename</code> <code class="c_id">T</code>, <code class="c_type">size_t</code> <code class="c_id">Size</code>,
+ <code class="c_keyword">class</code> <code class="c_id">HashFunctions</code>&gt;
+ <code class="c_type">bloom_filter</code>&lt;<code class="c_id">T, Size, HashFunctions</code>&gt;
+ <code class="c_func">operator|</code>(<code class="c_keyword">const</code> <code class="c_type">bloom_filter</code>&lt;<code class="c_id">T, Size, HashFunctions</code>&gt;&amp; <code class="c_id">lhs</code>,
+ <code class="c_keyword">const</code> <code class="c_type">bloom_filter</code>&lt;<code class="c_id">T, Size, HashFunctions</code>&gt;&amp; <code class="c_id">rhs</code>);
+
+ <code class="c_comment">// intersect</code>
+ <code class="c_keyword">template</code> &lt;<code class="c_keyword">typename</code> <code class="c_id">T</code>, <code class="c_type">size_t</code> <code class="c_id">Size</code>,
+ <code class="c_keyword">class</code> <code class="c_id">HashFunctions</code>&gt;
+ <code class="c_type">bloom_filter</code>&lt;<code class="c_id">T, Size, HashFunctions</code>&gt;
+ <code class="c_func">operator&amp;</code>(<code class="c_keyword">const</code> <code class="c_type">bloom_filter</code>&lt;<code class="c_id">T, Size, HashFunctions</code>&gt;&amp; <code class="c_id">lhs</code>,
+ <code class="c_keyword">const</code> <code class="c_type">bloom_filter</code>&lt;<code class="c_id">T, Size, HashFunctions</code>&gt;&amp; <code class="c_id">rhs</code>);
+ </div>
+ <p>
+ The basic Bloom filter data structure. Supports insertion and query.
+ </p>
+
+ <h2> Template Parameters Reference</h2>
+ <dl>
+ <dt>T</dt>
+ <dd>The type used for all Bloom filter operations.</dd>
+ <dt>Size</dt>
+ <dd>The size in bits of the underlying bitset used by the Bloom filter.</dd>
+ <dt>HashFunctions</dt>
+ <dd>The set of hash functions used by the Bloom filter. Currently required to be an mpl::vector of Hashers.</dd>
+ </dl>
+
+ <h2>Function Reference</h2>
+ <h5>Function name</h5>
+ <p>Description text</p>
+ <h6>Pre-condition</h6>
+ <h6>Post-condition</h6>
+ <h6>Returns</h6>
 
     <hr/>
     <div class="spirit-nav">
@@ -58,7 +120,7 @@
 
     <footer>
       <p>
- Last revised: <time datetime="2011-06-14">June 14, 2011</time>.
+ Last revised: <time datetime="2011-06-16">June 16, 2011</time>.
       </p>
 
       <p class="copyright">

Modified: sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/style/my.css
==============================================================================
--- sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/style/my.css (original)
+++ sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/style/my.css 2011-06-16 15:29:38 EDT (Thu, 16 Jun 2011)
@@ -54,7 +54,7 @@
     margin-left: 5%;
     margin-right: 5%;
     color: silver;
-};
+}
 
 .c_comment {
     color: maroon;
@@ -63,7 +63,7 @@
 code.c_comment a {
     color: maroon;
     text-decoration: underline;
-};
+}
 
 .c_include {
     color: purple;
@@ -110,5 +110,5 @@
 
 .spirit-nav img
 {
- border-width: 0px;
+ border-width: 0;
 }

Added: sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/testing.html
==============================================================================
--- (empty file)
+++ sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/testing.html 2011-06-16 15:29:38 EDT (Thu, 16 Jun 2011)
@@ -0,0 +1,89 @@
+<!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/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="bibliography.html">
+ <img src="../../../../doc/src/images/next.png" alt="Next"/>
+ </a>
+ </div>
+
+ <h1 class="title">Testing (Developers)</h1>
+ <p>
+ This portion of the documentation is directed especially at developers that are interested in contributing to the testing of Boost.BloomFilter.
+ </p>
+
+ <p>
+ Testing is performed as a series of test cases that evaluate the functionality of a test element. The current state of testing is as follows:
+ </p>
+ <ul>
+ <li>A single test file</li>
+ <li>Covers all operations of Bloom filter class</li>
+ <li>Covers construction using single and multiple HashFn parameters.</li>
+ </ul>
+
+ <p>
+ As the implementation grows, new test suites will need to be developed for alternate types of Bloom filters, with different policies, and different hash functions.
+ </p>
+
+ <hr/>
+ <div class="spirit-nav">
+ <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="bibliography.html">
+ <img src="../../../../doc/src/images/next.png" alt="Next"/>
+ </a>
+ </div>
+
+ <footer>
+ <p>
+ Last revised: <time datetime="2011-06-16">June 16, 2011</time>.
+ </p>
+
+ <p class="copyright">
+ Copyright &#169; 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>

Date view Thread view Subject view Author view

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