Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-14 12:38:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Documentation fixes.

Browse source 
This cleans up most of the warnings from sphinx (broken :doc: links,
broxygen role misuses, etc.).  The remaining ones should be harmless,
but not quick to silence.

I found that the README for each component was a copy from the actual
repo, so I turned those in to symlinks so they don't get out of date.
This commit is contained in:
Jon Siwek 2013-09-03 15:59:40 -05:00
parent 2392a29b7f
commit db470a637a
32 changed files with 123 additions and 5151 deletions
Download patch file Download diff file Expand all files Collapse all files

40
src/probabilistic/bloom-filter.bif
View file

@ -23,12 +23,13 @@ module GLOBAL;
## fp: The desired false-positive rate.
##
## capacity: the maximum number of elements that guarantees a false-positive
## rate of *fp*.
## rate of *fp*.
##
## name: A name that uniquely identifies and seeds the Bloom filter. If empty,
## the filter will use :bro:id:`global_hash_seed` if that's set, and otherwise use
## a local seed tied to the current Bro process. Only filters with the same seed
## can be merged with :bro:id:`bloomfilter_merge` .
## the filter will use :bro:id:`global_hash_seed` if that's set, and
## otherwise use a local seed tied to the current Bro process. Only
## filters with the same seed can be merged with
## :bro:id:`bloomfilter_merge` .
##
## Returns: A Bloom filter handle.
##
@ -61,13 +62,14 @@ function bloomfilter_basic_init%(fp: double, capacity: count,
## cells: The number of cells of the underlying bit vector.
##
## name: A name that uniquely identifies and seeds the Bloom filter. If empty,
## the filter will use :bro:id:`global_hash_seed` if that's set, and otherwise use
## a local seed tied to the current Bro process. Only filters with the same seed
## can be merged with :bro:id:`bloomfilter_merge` .
## the filter will use :bro:id:`global_hash_seed` if that's set, and
## otherwise use a local seed tied to the current Bro process. Only
## filters with the same seed can be merged with
## :bro:id:`bloomfilter_merge` .
##
## Returns: A Bloom filter handle.
##
## .. bro:see:: bloom_filter_basic_init bloomfilter_counting_init bloomfilter_add
## .. bro:see:: bloomfilter_basic_init bloomfilter_counting_init bloomfilter_add
## bloomfilter_lookup bloomfilter_clear bloomfilter_merge global_hash_seed
function bloomfilter_basic_init2%(k: count, cells: count,
name: string &default=""%): opaque of bloomfilter
@ -94,18 +96,20 @@ function bloomfilter_basic_init2%(k: count, cells: count,
##
## k: The number of hash functions to use.
##
## cells: The number of cells of the underlying counter vector. As there's no
## single answer to what's the best parameterization for a counting Bloom filter,
## we refer to the Bloom filter literature here for choosing an appropiate value.
## cells: The number of cells of the underlying counter vector. As there's
## no single answer to what's the best parameterization for a
## counting Bloom filter, we refer to the Bloom filter literature
## here for choosing an appropiate value.
##
## max: The maximum counter value associated with each each element described
## by *w = ceil(log_2(max))* bits. Each bit in the underlying counter vector
## becomes a cell of size *w* bits.
## max: The maximum counter value associated with each each element
## described by *w = ceil(log_2(max))* bits. Each bit in the underlying
## counter vector becomes a cell of size *w* bits.
##
## name: A name that uniquely identifies and seeds the Bloom filter. If empty,
## the filter will use :bro:id:`global_hash_seed` if that's set, and otherwise use
## a local seed tied to the current Bro process. Only filters with the same seed
## can be merged with :bro:id:`bloomfilter_merge` .
## the filter will use :bro:id:`global_hash_seed` if that's set, and
## otherwise use a local seed tied to the current Bro process. Only
## filters with the same seed can be merged with
## :bro:id:`bloomfilter_merge` .
##
## Returns: A Bloom filter handle.
##
@ -193,7 +197,7 @@ function bloomfilter_lookup%(bf: opaque of bloomfilter, x: any%): count
##
## bf: The Bloom filter handle.
##
## .. bro:see:: bloomfilter_basic_init bloomfilter_counting_init2
## .. bro:see:: bloomfilter_basic_init bloomfilter_basic_init2
## bloomfilter_counting_init bloomfilter_add bloomfilter_lookup
## bloomfilter_merge
function bloomfilter_clear%(bf: opaque of bloomfilter%): any