The cl-bloom-filter Reference Manual

This is the cl-bloom-filter Reference Manual, version 0.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 19:53:17 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 cl-bloom-filter

License
Version

0.1.0

Source

cl-bloom-filter.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 cl-bloom-filter/src

Source

cl-bloom-filter.asd.

Parent Component

cl-bloom-filter (system).

Child Components

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


4.1 Lisp


4.1.1 cl-bloom-filter/cl-bloom-filter.asd

Source

cl-bloom-filter.asd.

Parent Component

cl-bloom-filter (system).

ASDF Systems

cl-bloom-filter.


4.1.2 cl-bloom-filter/src/package.lisp

Source

cl-bloom-filter.asd.

Parent Component

src (module).

Packages

cl-bloom-filter.


4.1.3 cl-bloom-filter/src/helpers.lisp

Source

cl-bloom-filter.asd.

Parent Component

src (module).

Internals

4.1.4 cl-bloom-filter/src/main.lisp

Source

cl-bloom-filter.asd.

Parent Component

src (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 cl-bloom-filter

Source

package.lisp.

Nickname

bf

Use List

common-lisp.

Public Interface
Internals

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


6.1 Public Interface


6.1.1 Ordinary functions

Function: make-bloom-filter (&key hash-function expected-fp-rate expected-number-of-elements)
Package

cl-bloom-filter.

Source

main.lisp.


6.1.2 Generic functions

Generic Function: add (bloom-filter item)

Add item to the bloom filter

Package

cl-bloom-filter.

Source

main.lisp.

Methods
Method: add ((bloom-filter bloom-filter) item)
Method: add :after ((bloom-filter bloom-filter) item)
Generic Function: effective-fp-rate (bloom-filter)

Effective false positive rate

Package

cl-bloom-filter.

Source

main.lisp.

Methods
Method: effective-fp-rate ((bloom-filter bloom-filter))
Generic Reader: expected-fp-rate (object)
Package

cl-bloom-filter.

Methods
Reader Method: expected-fp-rate ((bloom-filter bloom-filter))

automatically generated reader method

Source

main.lisp.

Target Slot

expected-fp-rate.

Generic Writer: (setf expected-fp-rate) (object)
Package

cl-bloom-filter.

Methods
Writer Method: (setf expected-fp-rate) ((bloom-filter bloom-filter))

automatically generated writer method

Source

main.lisp.

Target Slot

expected-fp-rate.

Generic Reader: expected-number-of-elements (object)
Package

cl-bloom-filter.

Methods
Reader Method: expected-number-of-elements ((bloom-filter bloom-filter))

automatically generated reader method

Source

main.lisp.

Target Slot

expected-number-of-elements.

Generic Writer: (setf expected-number-of-elements) (object)
Package

cl-bloom-filter.

Methods
Writer Method: (setf expected-number-of-elements) ((bloom-filter bloom-filter))

automatically generated writer method

Source

main.lisp.

Target Slot

expected-number-of-elements.

Generic Reader: hash-function (object)
Package

cl-bloom-filter.

Methods
Reader Method: hash-function ((bloom-filter bloom-filter))

automatically generated reader method

Source

main.lisp.

Target Slot

hash-function.

Generic Writer: (setf hash-function) (object)
Package

cl-bloom-filter.

Methods
Writer Method: (setf hash-function) ((bloom-filter bloom-filter))

automatically generated writer method

Source

main.lisp.

Target Slot

hash-function.

Generic Function: lookup (bloom-filter item)

Check if item is member of the bloom filter

Package

cl-bloom-filter.

Source

main.lisp.

Methods
Method: lookup ((bloom-filter bloom-filter) item)
Generic Reader: number-of-elements (object)
Package

cl-bloom-filter.

Methods
Reader Method: number-of-elements ((bloom-filter bloom-filter))

automatically generated reader method

Source

main.lisp.

Target Slot

number-of-elements.

Generic Writer: (setf number-of-elements) (object)
Package

cl-bloom-filter.

Methods
Writer Method: (setf number-of-elements) ((bloom-filter bloom-filter))

automatically generated writer method

Source

main.lisp.

Target Slot

number-of-elements.


6.1.3 Standalone methods

Method: initialize-instance :after ((bloom-filter bloom-filter) &key)
Source

main.lisp.


6.2 Internals


6.2.1 Macros

Macro: %do-for-each-item-digest (bloom-filter item &body body)
Package

cl-bloom-filter.

Source

main.lisp.


6.2.2 Ordinary functions

Function: %fp-rate (n m k)
Package

cl-bloom-filter.

Source

helpers.lisp.

Function: %optimal-number-of-bits (n fp)
Package

cl-bloom-filter.

Source

helpers.lisp.

Function: %optimal-number-of-hash-functions (n m)
Package

cl-bloom-filter.

Source

helpers.lisp.


6.2.3 Generic functions

Generic Function: %get-bit (bloom-filter hashed-item)
Package

cl-bloom-filter.

Methods
Method: %get-bit ((bloom-filter bloom-filter) hashed-item)
Source

main.lisp.

Generic Function: %set-bit (bloom-filter hashed-item)
Package

cl-bloom-filter.

Methods
Method: %set-bit ((bloom-filter bloom-filter) hashed-item)
Source

main.lisp.

Generic Function: %size (bloom-filter)
Package

cl-bloom-filter.

Methods
Method: %size ((bloom-filter bloom-filter))
Source

main.lisp.

Generic Reader: hash-set (object)
Package

cl-bloom-filter.

Methods
Reader Method: hash-set ((bloom-filter bloom-filter))

automatically generated reader method

Source

main.lisp.

Target Slot

hash-set.

Generic Writer: (setf hash-set) (object)
Package

cl-bloom-filter.

Methods
Writer Method: (setf hash-set) ((bloom-filter bloom-filter))

automatically generated writer method

Source

main.lisp.

Target Slot

hash-set.

Generic Reader: number-of-hash-functions (object)
Package

cl-bloom-filter.

Methods
Reader Method: number-of-hash-functions ((bloom-filter bloom-filter))

automatically generated reader method

Source

main.lisp.

Target Slot

number-of-hash-functions.

Generic Writer: (setf number-of-hash-functions) (object)
Package

cl-bloom-filter.

Methods
Writer Method: (setf number-of-hash-functions) ((bloom-filter bloom-filter))

automatically generated writer method

Source

main.lisp.

Target Slot

number-of-hash-functions.


6.2.4 Classes

Class: bloom-filter
Package

cl-bloom-filter.

Source

main.lisp.

Direct methods
Direct slots
Slot: expected-number-of-elements
Initargs

:expected-number-of-elements

Readers

expected-number-of-elements.

Writers

(setf expected-number-of-elements).

Slot: expected-fp-rate
Initargs

:expected-fp-rate

Readers

expected-fp-rate.

Writers

(setf expected-fp-rate).

Slot: hash-function
Initargs

:hash-function

Readers

hash-function.

Writers

(setf hash-function).

Slot: hash-set
Readers

hash-set.

Writers

(setf hash-set).

Slot: number-of-hash-functions
Readers

number-of-hash-functions.

Writers

(setf number-of-hash-functions).

Slot: number-of-elements
Initform

0

Readers

number-of-elements.

Writers

(setf number-of-elements).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
A   E   F   G   H   I   L   M   N  
Index Entry  Section

%
%do-for-each-item-digest: Private macros
%fp-rate: Private ordinary functions
%get-bit: Private generic functions
%get-bit: Private generic functions
%optimal-number-of-bits: Private ordinary functions
%optimal-number-of-hash-functions: Private ordinary functions
%set-bit: Private generic functions
%set-bit: Private generic functions
%size: Private generic functions
%size: Private generic functions

(
(setf expected-fp-rate): Public generic functions
(setf expected-fp-rate): Public generic functions
(setf expected-number-of-elements): Public generic functions
(setf expected-number-of-elements): Public generic functions
(setf hash-function): Public generic functions
(setf hash-function): Public generic functions
(setf hash-set): Private generic functions
(setf hash-set): Private generic functions
(setf number-of-elements): Public generic functions
(setf number-of-elements): Public generic functions
(setf number-of-hash-functions): Private generic functions
(setf number-of-hash-functions): Private generic functions

A
add: Public generic functions
add: Public generic functions
add: Public generic functions

E
effective-fp-rate: Public generic functions
effective-fp-rate: Public generic functions
expected-fp-rate: Public generic functions
expected-fp-rate: Public generic functions
expected-number-of-elements: Public generic functions
expected-number-of-elements: Public generic functions

F
Function, %fp-rate: Private ordinary functions
Function, %optimal-number-of-bits: Private ordinary functions
Function, %optimal-number-of-hash-functions: Private ordinary functions
Function, make-bloom-filter: Public ordinary functions

G
Generic Function, %get-bit: Private generic functions
Generic Function, %set-bit: Private generic functions
Generic Function, %size: Private generic functions
Generic Function, (setf expected-fp-rate): Public generic functions
Generic Function, (setf expected-number-of-elements): Public generic functions
Generic Function, (setf hash-function): Public generic functions
Generic Function, (setf hash-set): Private generic functions
Generic Function, (setf number-of-elements): Public generic functions
Generic Function, (setf number-of-hash-functions): Private generic functions
Generic Function, add: Public generic functions
Generic Function, effective-fp-rate: Public generic functions
Generic Function, expected-fp-rate: Public generic functions
Generic Function, expected-number-of-elements: Public generic functions
Generic Function, hash-function: Public generic functions
Generic Function, hash-set: Private generic functions
Generic Function, lookup: Public generic functions
Generic Function, number-of-elements: Public generic functions
Generic Function, number-of-hash-functions: Private generic functions

H
hash-function: Public generic functions
hash-function: Public generic functions
hash-set: Private generic functions
hash-set: Private generic functions

I
initialize-instance: Public standalone methods

L
lookup: Public generic functions
lookup: Public generic functions

M
Macro, %do-for-each-item-digest: Private macros
make-bloom-filter: Public ordinary functions
Method, %get-bit: Private generic functions
Method, %set-bit: Private generic functions
Method, %size: Private generic functions
Method, (setf expected-fp-rate): Public generic functions
Method, (setf expected-number-of-elements): Public generic functions
Method, (setf hash-function): Public generic functions
Method, (setf hash-set): Private generic functions
Method, (setf number-of-elements): Public generic functions
Method, (setf number-of-hash-functions): Private generic functions
Method, add: Public generic functions
Method, add: Public generic functions
Method, effective-fp-rate: Public generic functions
Method, expected-fp-rate: Public generic functions
Method, expected-number-of-elements: Public generic functions
Method, hash-function: Public generic functions
Method, hash-set: Private generic functions
Method, initialize-instance: Public standalone methods
Method, lookup: Public generic functions
Method, number-of-elements: Public generic functions
Method, number-of-hash-functions: Private generic functions

N
number-of-elements: Public generic functions
number-of-elements: Public generic functions
number-of-hash-functions: Private generic functions
number-of-hash-functions: Private generic functions