Skip to content

Commit

Permalink
updated autodocs
Browse files Browse the repository at this point in the history
  • Loading branch information
Kyle Burton committed Nov 20, 2010
1 parent ab4fc7d commit ba1d7ab
Show file tree
Hide file tree
Showing 13 changed files with 688 additions and 0 deletions.
218 changes: 218 additions & 0 deletions docs/api-index.html
View file
@@ -0,0 +1,218 @@
<html>
<head>
<title>clj-bloom - Index</title>
<link href="static/favicon.png" rel="icon" />
<link href="static/favicon.png" rel="shortcut icon" />
<link media="all" type="text/css" href="static/clojure.css" rel="stylesheet" />
<link media="all" type="text/css" href="static/wiki.css" rel="stylesheet" />
<link media="all" type="text/css" href="static/internal.css" rel="stylesheet" />
<!-- TODO: are we using these (from clojure.org)? If so, add the files -->
<script src="file/view/code_highlighter.js" type="text/javascript"></script>
<script src="file/view/clojure.js" type="text/javascript"></script>
<style>.menuWrapper{height: 36px;}</style>
<!--[if lte IE 6]>
<link rel="stylesheet" href="http://www.wikispaces.com/_/2009051601/s/internal_ie.css" type="text/css" />
<![endif]-->
</head>
<!--
This document was auto-generated from the source by the clojure autodoc system.
To report errors or ask questions about the overall documentation structure, formatting,
etc., contact Tom Faulhaber (google mail name: tomfaulhaber).
For errors in the documentation of a particular namespace, contact the author of that
namespace.
-->
<body>
<div id="AllContentContainer">
<div id="Header">
<a id="Logo" href="index.html"><img alt="Clojure" height="100" width="100" src="static/clojure-icon.gif" /></a>
<h1><a title="page header title" id="page-header" href="index.html">clj-bloom: API Documentation</a></h1>
</div>
<div id="leftcolumn"><div style="text-align: center;"></div>
<div class="menu">
<div class="WikiCustomNav WikiElement wiki">
<a class="wiki_link" href="index.html">Overview</a><br />
<a class="wiki_link" href="api-index.html">API Index</a><br />
<a class="wiki_link" href="#">Namespaces:</a>
<ul id="left-sidebar-list">
<li><a href="com.github.kyleburton.clj-bloom-api.html" class="wiki_link">com.github.kyleburton.clj-bloom</a></li>
</ul>
</div>
</div>
</div>
<div id="rightcolumn">
<div id="Content">
<div class="contentBox"><div class="innerContentBox">
<div id="content_view" class="wiki wikiPage">
<div id="right-sidebar"></div>
<div id="content-tag"><h1 id="overview">Index of Public Functions and Variables in <span class="project-name-span">clj-bloom</span></h1>
This page has an alphabetical index of all the documented functions and variables
in <span class="project-name-span">clj-bloom</span>.

<!-- TODO: enable this functionality on github?
In a narrow browser window, you may want to collapse the sidebar (use the \"<<\" link)
to get more screen space for the index.
-->

<div class="shortcuts">
Shortcuts:<br />
<a href="#A">A</a> <a href="#B">B</a> <a href="#C">C</a> <a href="#D">D</a>
<a href="#E">E</a> <a href="#F">F</a> <a href="#G">G</a> <a href="#H">H</a>
<a href="#I">I</a> <a href="#J">J</a> <a href="#K">K</a> <a href="#L">L</a>
<a href="#M">M</a>
<br />
<a href="#N">N</a> <a href="#O">O</a> <a href="#P">P</a> <a href="#Q">Q</a>
<a href="#R">R</a> <a href="#S">S</a> <a href="#T">T</a> <a href="#U">U</a>
<a href="#V">V</a> <a href="#W">W</a> <a href="#X">X</a> <a href="#Y">Y</a>
<a href="#Z">Z</a>
<br />
<a href="#Other">Other</a>
<br />
</div>

<div id="index-body">
<h2 id="A"><span id="section-head">A</span></h2>
<pre>
<span id="section-content"> <a href="com.github.kyleburton.clj-bloom-api.html#com.github.kyleburton.clj-bloom/add!">add!</a><span id="line-content"> function com.github.kyleburton.clj-bloom Add a string into the filter by execu...
</span></span></pre>
</div><div id="index-body">
<h2 id="B"><span id="section-head">B</span></h2>
<pre>
<span id="section-content"> <a href="com.github.kyleburton.clj-bloom-api.html#com.github.kyleburton.clj-bloom/bloom-filter">bloom-filter</a><span id="line-content"> function com.github.kyleburton.clj-bloom Construct a Bloom Filter with a given...
</span></span></pre>
</div><div id="index-body">
<h2 id="C"><span id="section-head">C</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="D"><span id="section-head">D</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="E"><span id="section-head">E</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="F"><span id="section-head">F</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="G"><span id="section-head">G</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="H"><span id="section-head">H</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="I"><span id="section-head">I</span></h2>
<pre>
<span id="section-content"> <a href="com.github.kyleburton.clj-bloom-api.html#com.github.kyleburton.clj-bloom/include?">include?</a><span id="line-content"> function com.github.kyleburton.clj-bloom Test if a string is included in the f...
</span></span><span id="section-content"> <a href="com.github.kyleburton.clj-bloom-api.html#com.github.kyleburton.clj-bloom/insertions">insertions</a><span id="line-content"> function com.github.kyleburton.clj-bloom Returns the number of insertions that...
</span></span></pre>
</div><div id="index-body">
<h2 id="J"><span id="section-head">J</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="K"><span id="section-head">K</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="L"><span id="section-head">L</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="M"><span id="section-head">M</span></h2>
<pre>
<span id="section-content"> <a href="com.github.kyleburton.clj-bloom-api.html#com.github.kyleburton.clj-bloom/make-adler32">make-adler32</a><span id="line-content"> function com.github.kyleburton.clj-bloom Create `k' permuted hash functions us...
</span></span><span id="section-content"> <a href="com.github.kyleburton.clj-bloom-api.html#com.github.kyleburton.clj-bloom/make-crc32">make-crc32</a><span id="line-content"> function com.github.kyleburton.clj-bloom Create `k' permuted hash functions us...
</span></span><span id="section-content"> <a href="com.github.kyleburton.clj-bloom-api.html#com.github.kyleburton.clj-bloom/make-hash-fn-adler32">make-hash-fn-adler32</a><span id="line-content"> function com.github.kyleburton.clj-bloom Creates an adler32 hash function, wit...
</span></span><span id="section-content"> <a href="com.github.kyleburton.clj-bloom-api.html#com.github.kyleburton.clj-bloom/make-hash-fn-crc32">make-hash-fn-crc32</a><span id="line-content"> function com.github.kyleburton.clj-bloom Creates a crc32 hash function, with `...
</span></span><span id="section-content"> <a href="com.github.kyleburton.clj-bloom-api.html#com.github.kyleburton.clj-bloom/make-hash-fn-hash-code">make-hash-fn-hash-code</a><span id="line-content"> function com.github.kyleburton.clj-bloom Returns a funciton that will take a s...
</span></span><span id="section-content"> <a href="com.github.kyleburton.clj-bloom-api.html#com.github.kyleburton.clj-bloom/make-hash-fn-md5">make-hash-fn-md5</a><span id="line-content"> function com.github.kyleburton.clj-bloom Creates an md5 hash function, with `x...
</span></span><span id="section-content"> <a href="com.github.kyleburton.clj-bloom-api.html#com.github.kyleburton.clj-bloom/make-hash-fn-sha1">make-hash-fn-sha1</a><span id="line-content"> function com.github.kyleburton.clj-bloom Creates a sha1 hash function, with `x...
</span></span><span id="section-content"> <a href="com.github.kyleburton.clj-bloom-api.html#com.github.kyleburton.clj-bloom/make-md5">make-md5</a><span id="line-content"> function com.github.kyleburton.clj-bloom Create `k' permuted hash functions us...
</span></span><span id="section-content"> <a href="com.github.kyleburton.clj-bloom-api.html#com.github.kyleburton.clj-bloom/make-optimal-filter">make-optimal-filter</a><span id="line-content"> function com.github.kyleburton.clj-bloom Create an optimal filter for the esti...
</span></span><span id="section-content"> <a href="com.github.kyleburton.clj-bloom-api.html#com.github.kyleburton.clj-bloom/make-permuted-hash-fn">make-permuted-hash-fn</a><span id="line-content"> function com.github.kyleburton.clj-bloom Given a base hash function, and a vec...
</span></span><span id="section-content"> <a href="com.github.kyleburton.clj-bloom-api.html#com.github.kyleburton.clj-bloom/make-sha1">make-sha1</a><span id="line-content"> function com.github.kyleburton.clj-bloom Create `k' permuted hash functions us...
</span></span></pre>
</div><div id="index-body">
<h2 id="N"><span id="section-head">N</span></h2>
<pre>
<span id="section-content"> <a href="com.github.kyleburton.clj-bloom-api.html#com.github.kyleburton.clj-bloom/num-bits-for-entries-and-fp-probability">num-bits-for-entries-and-fp-probability</a><span id="line-content"> function com.github.kyleburton.clj-bloom Computes a Bloom Filter (bit array) s...
</span></span><span id="section-content"> <a href="com.github.kyleburton.clj-bloom-api.html#com.github.kyleburton.clj-bloom/num-hash-fns-for-entries-and-bits">num-hash-fns-for-entries-and-bits</a><span id="line-content"> function com.github.kyleburton.clj-bloom Computes the optimialnumber of hash f...
</span></span></pre>
</div><div id="index-body">
<h2 id="O"><span id="section-head">O</span></h2>
<pre>
<span id="section-content"> <a href="com.github.kyleburton.clj-bloom-api.html#com.github.kyleburton.clj-bloom/optimal-n-and-k">optimal-n-and-k</a><span id="line-content"> function com.github.kyleburton.clj-bloom Compute the optimal filter size (numb...
</span></span></pre>
</div><div id="index-body">
<h2 id="P"><span id="section-head">P</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="Q"><span id="section-head">Q</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="R"><span id="section-head">R</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="S"><span id="section-head">S</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="T"><span id="section-head">T</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="U"><span id="section-head">U</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="V"><span id="section-head">V</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="W"><span id="section-head">W</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="X"><span id="section-head">X</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="Y"><span id="section-head">Y</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="Z"><span id="section-head">Z</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="Other"><span id="section-head">Other</span></h2>
<pre>
</pre>
</div>
<style type="text/css">
#AllContentContainer {min-width: 96em;}
</style>
</div>
</div>
</div>
</div>
</div>
<div id="foot">
<div style="text-align: center;" id="copyright">No copyright info </div>
</div>
</div>
<div id="DesignedBy">Logo &amp; site design by <a title="Visit Tom Hickey's website." href="http://www.tomhickey.com">Tom Hickey</a>.<br />
Clojure auto-documentation system by Tom Faulhaber.</div>
</div>
<!-- /AllContentContainer -->
</body>

</html>

0 comments on commit ba1d7ab

Please sign in to comment.