mirror of
https://github.com/zeek/zeek.git
synced 2025-10-12 11:38:20 +00:00
GH-234: rename Broxygen to Zeexygen along with roles/directives
* All "Broxygen" usages have been replaced in code, documentation, filenames, etc. * Sphinx roles/directives like ":bro:see" are now ":zeek:see" * The "--broxygen" command-line option is now "--zeexygen"
This commit is contained in:
Jon Siwek
parent
5ba46eaa71
commit
aebcb1415d
254 changed files with 2675 additions and 2656 deletions
|
|
@ -22,14 +22,14 @@ module GLOBAL;
|
|||
## 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
|
||||
## the filter will use :zeek: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`.
|
||||
## :zeek:id:`bloomfilter_merge`.
|
||||
##
|
||||
## Returns: A Bloom filter handle.
|
||||
##
|
||||
## .. bro:see:: bloomfilter_basic_init2 bloomfilter_counting_init bloomfilter_add
|
||||
## .. zeek:see:: bloomfilter_basic_init2 bloomfilter_counting_init bloomfilter_add
|
||||
## bloomfilter_lookup bloomfilter_clear bloomfilter_merge global_hash_seed
|
||||
function bloomfilter_basic_init%(fp: double, capacity: count,
|
||||
name: string &default=""%): opaque of bloomfilter
|
||||
|
|
@ -50,7 +50,7 @@ function bloomfilter_basic_init%(fp: double, capacity: count,
|
|||
%}
|
||||
|
||||
## Creates a basic Bloom filter. This function serves as a low-level
|
||||
## alternative to :bro:id:`bloomfilter_basic_init` where the user has full
|
||||
## alternative to :zeek:id:`bloomfilter_basic_init` where the user has full
|
||||
## control over the number of hash functions and cells in the underlying bit
|
||||
## vector.
|
||||
##
|
||||
|
|
@ -59,14 +59,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
|
||||
## the filter will use :zeek: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`.
|
||||
## :zeek:id:`bloomfilter_merge`.
|
||||
##
|
||||
## Returns: A Bloom filter handle.
|
||||
##
|
||||
## .. bro:see:: bloomfilter_basic_init bloomfilter_counting_init bloomfilter_add
|
||||
## .. zeek: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
|
||||
|
|
@ -103,14 +103,14 @@ function bloomfilter_basic_init2%(k: count, cells: count,
|
|||
## 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
|
||||
## the filter will use :zeek: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`.
|
||||
## :zeek:id:`bloomfilter_merge`.
|
||||
##
|
||||
## Returns: A Bloom filter handle.
|
||||
##
|
||||
## .. bro:see:: bloomfilter_basic_init bloomfilter_basic_init2 bloomfilter_add
|
||||
## .. zeek:see:: bloomfilter_basic_init bloomfilter_basic_init2 bloomfilter_add
|
||||
## bloomfilter_lookup bloomfilter_clear bloomfilter_merge global_hash_seed
|
||||
function bloomfilter_counting_init%(k: count, cells: count, max: count,
|
||||
name: string &default=""%): opaque of bloomfilter
|
||||
|
|
@ -139,7 +139,7 @@ function bloomfilter_counting_init%(k: count, cells: count, max: count,
|
|||
##
|
||||
## x: The element to add.
|
||||
##
|
||||
## .. bro:see:: bloomfilter_basic_init bloomfilter_basic_init2
|
||||
## .. zeek:see:: bloomfilter_basic_init bloomfilter_basic_init2
|
||||
## bloomfilter_counting_init bloomfilter_lookup bloomfilter_clear
|
||||
## bloomfilter_merge
|
||||
function bloomfilter_add%(bf: opaque of bloomfilter, x: any%): any
|
||||
|
|
@ -166,7 +166,7 @@ function bloomfilter_add%(bf: opaque of bloomfilter, x: any%): any
|
|||
##
|
||||
## Returns: the counter associated with *x* in *bf*.
|
||||
##
|
||||
## .. bro:see:: bloomfilter_basic_init bloomfilter_basic_init2
|
||||
## .. zeek:see:: bloomfilter_basic_init bloomfilter_basic_init2
|
||||
## bloomfilter_counting_init bloomfilter_add bloomfilter_clear
|
||||
## bloomfilter_merge
|
||||
function bloomfilter_lookup%(bf: opaque of bloomfilter, x: any%): count
|
||||
|
|
@ -191,7 +191,7 @@ function bloomfilter_lookup%(bf: opaque of bloomfilter, x: any%): count
|
|||
##
|
||||
## bf: The Bloom filter handle.
|
||||
##
|
||||
## .. bro:see:: bloomfilter_basic_init bloomfilter_basic_init2
|
||||
## .. zeek:see:: bloomfilter_basic_init bloomfilter_basic_init2
|
||||
## bloomfilter_counting_init bloomfilter_add bloomfilter_lookup
|
||||
## bloomfilter_merge
|
||||
function bloomfilter_clear%(bf: opaque of bloomfilter%): any
|
||||
|
|
@ -216,7 +216,7 @@ function bloomfilter_clear%(bf: opaque of bloomfilter%): any
|
|||
##
|
||||
## Returns: The union of *bf1* and *bf2*.
|
||||
##
|
||||
## .. bro:see:: bloomfilter_basic_init bloomfilter_basic_init2
|
||||
## .. zeek:see:: bloomfilter_basic_init bloomfilter_basic_init2
|
||||
## bloomfilter_counting_init bloomfilter_add bloomfilter_lookup
|
||||
## bloomfilter_clear
|
||||
function bloomfilter_merge%(bf1: opaque of bloomfilter,
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ module GLOBAL;
|
|||
##
|
||||
## Returns: a HLL cardinality handle.
|
||||
##
|
||||
## .. bro:see:: hll_cardinality_estimate hll_cardinality_merge_into hll_cardinality_add
|
||||
## .. zeek:see:: hll_cardinality_estimate hll_cardinality_merge_into hll_cardinality_add
|
||||
## hll_cardinality_copy
|
||||
function hll_cardinality_init%(err: double, confidence: double%): opaque of cardinality
|
||||
%{
|
||||
|
|
@ -35,7 +35,7 @@ function hll_cardinality_init%(err: double, confidence: double%): opaque of card
|
|||
##
|
||||
## Returns: true on success.
|
||||
##
|
||||
## .. bro:see:: hll_cardinality_estimate hll_cardinality_merge_into
|
||||
## .. zeek:see:: hll_cardinality_estimate hll_cardinality_merge_into
|
||||
## hll_cardinality_init hll_cardinality_copy
|
||||
function hll_cardinality_add%(handle: opaque of cardinality, elem: any%): bool
|
||||
%{
|
||||
|
|
@ -60,7 +60,7 @@ function hll_cardinality_add%(handle: opaque of cardinality, elem: any%): bool
|
|||
## Merges a HLL cardinality counter into another.
|
||||
##
|
||||
## .. note:: The same restrictions as for Bloom filter merging apply,
|
||||
## see :bro:id:`bloomfilter_merge`.
|
||||
## see :zeek:id:`bloomfilter_merge`.
|
||||
##
|
||||
## handle1: the first HLL handle, which will contain the merged result.
|
||||
##
|
||||
|
|
@ -68,7 +68,7 @@ function hll_cardinality_add%(handle: opaque of cardinality, elem: any%): bool
|
|||
##
|
||||
## Returns: true on success.
|
||||
##
|
||||
## .. bro:see:: hll_cardinality_estimate hll_cardinality_add
|
||||
## .. zeek:see:: hll_cardinality_estimate hll_cardinality_add
|
||||
## hll_cardinality_init hll_cardinality_copy
|
||||
function hll_cardinality_merge_into%(handle1: opaque of cardinality, handle2: opaque of cardinality%): bool
|
||||
%{
|
||||
|
|
@ -103,7 +103,7 @@ function hll_cardinality_merge_into%(handle1: opaque of cardinality, handle2: op
|
|||
##
|
||||
## Returns: the cardinality estimate. Returns -1.0 if the counter is empty.
|
||||
##
|
||||
## .. bro:see:: hll_cardinality_merge_into hll_cardinality_add
|
||||
## .. zeek:see:: hll_cardinality_merge_into hll_cardinality_add
|
||||
## hll_cardinality_init hll_cardinality_copy
|
||||
function hll_cardinality_estimate%(handle: opaque of cardinality%): double
|
||||
%{
|
||||
|
|
@ -121,7 +121,7 @@ function hll_cardinality_estimate%(handle: opaque of cardinality%): double
|
|||
##
|
||||
## Returns: copy of handle.
|
||||
##
|
||||
## .. bro:see:: hll_cardinality_estimate hll_cardinality_merge_into hll_cardinality_add
|
||||
## .. zeek:see:: hll_cardinality_estimate hll_cardinality_merge_into hll_cardinality_add
|
||||
## hll_cardinality_init
|
||||
function hll_cardinality_copy%(handle: opaque of cardinality%): opaque of cardinality
|
||||
%{
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@
|
|||
##
|
||||
## Returns: Opaque pointer to the data structure.
|
||||
##
|
||||
## .. bro:see:: topk_add topk_get_top topk_count topk_epsilon
|
||||
## .. zeek:see:: topk_add topk_get_top topk_count topk_epsilon
|
||||
## topk_size topk_sum topk_merge topk_merge_prune
|
||||
function topk_init%(size: count%): opaque of topk
|
||||
%{
|
||||
|
|
@ -28,7 +28,7 @@ function topk_init%(size: count%): opaque of topk
|
|||
##
|
||||
## value: observed value.
|
||||
##
|
||||
## .. bro:see:: topk_init topk_get_top topk_count topk_epsilon
|
||||
## .. zeek:see:: topk_init topk_get_top topk_count topk_epsilon
|
||||
## topk_size topk_sum topk_merge topk_merge_prune
|
||||
function topk_add%(handle: opaque of topk, value: any%): any
|
||||
%{
|
||||
|
|
@ -47,7 +47,7 @@ function topk_add%(handle: opaque of topk, value: any%): any
|
|||
##
|
||||
## Returns: vector of the first k elements.
|
||||
##
|
||||
## .. bro:see:: topk_init topk_add topk_count topk_epsilon
|
||||
## .. zeek:see:: topk_init topk_add topk_count topk_epsilon
|
||||
## topk_size topk_sum topk_merge topk_merge_prune
|
||||
function topk_get_top%(handle: opaque of topk, k: count%): any_vec
|
||||
%{
|
||||
|
|
@ -68,7 +68,7 @@ function topk_get_top%(handle: opaque of topk, k: count%): any_vec
|
|||
##
|
||||
## Returns: Overestimated number for how often the element has been encountered.
|
||||
##
|
||||
## .. bro:see:: topk_init topk_add topk_get_top topk_epsilon
|
||||
## .. zeek:see:: topk_init topk_add topk_get_top topk_epsilon
|
||||
## topk_size topk_sum topk_merge topk_merge_prune
|
||||
function topk_count%(handle: opaque of topk, value: any%): count
|
||||
%{
|
||||
|
|
@ -79,7 +79,7 @@ function topk_count%(handle: opaque of topk, value: any%): count
|
|||
|
||||
## Get the maximal overestimation for count.
|
||||
##
|
||||
## .. note:: Same restrictions as for :bro:id:`topk_count` apply.
|
||||
## .. note:: Same restrictions as for :zeek:id:`topk_count` apply.
|
||||
##
|
||||
## handle: the TopK handle.
|
||||
##
|
||||
|
|
@ -88,7 +88,7 @@ function topk_count%(handle: opaque of topk, value: any%): count
|
|||
## Returns: Number which represents the maximal overestimation for the count of
|
||||
## this element.
|
||||
##
|
||||
## .. bro:see:: topk_init topk_add topk_get_top topk_count
|
||||
## .. zeek:see:: topk_init topk_add topk_get_top topk_count
|
||||
## topk_size topk_sum topk_merge topk_merge_prune
|
||||
function topk_epsilon%(handle: opaque of topk, value: any%): count
|
||||
%{
|
||||
|
|
@ -107,7 +107,7 @@ function topk_epsilon%(handle: opaque of topk, value: any%): count
|
|||
##
|
||||
## Returns: size given during initialization.
|
||||
##
|
||||
## .. bro:see:: topk_init topk_add topk_get_top topk_count topk_epsilon
|
||||
## .. zeek:see:: topk_init topk_add topk_get_top topk_count topk_epsilon
|
||||
## topk_sum topk_merge topk_merge_prune
|
||||
function topk_size%(handle: opaque of topk%): count
|
||||
%{
|
||||
|
|
@ -120,14 +120,14 @@ function topk_size%(handle: opaque of topk%): count
|
|||
##
|
||||
## .. note:: This is equal to the number of all inserted objects if the data
|
||||
## structure never has been pruned. Do not use after
|
||||
## calling :bro:id:`topk_merge_prune` (will throw a warning message if used
|
||||
## calling :zeek:id:`topk_merge_prune` (will throw a warning message if used
|
||||
## afterwards).
|
||||
##
|
||||
## handle: the TopK handle.
|
||||
##
|
||||
## Returns: sum of all counts.
|
||||
##
|
||||
## .. bro:see:: topk_init topk_add topk_get_top topk_count topk_epsilon
|
||||
## .. zeek:see:: topk_init topk_add topk_get_top topk_count topk_epsilon
|
||||
## topk_size topk_merge topk_merge_prune
|
||||
function topk_sum%(handle: opaque of topk%): count
|
||||
%{
|
||||
|
|
@ -145,7 +145,7 @@ function topk_sum%(handle: opaque of topk%): count
|
|||
## .. note:: This does not remove any elements, the resulting data structure
|
||||
## can be bigger than the maximum size given on initialization.
|
||||
##
|
||||
## .. bro:see:: topk_init topk_add topk_get_top topk_count topk_epsilon
|
||||
## .. zeek:see:: topk_init topk_add topk_get_top topk_count topk_epsilon
|
||||
## topk_size topk_sum topk_merge_prune
|
||||
function topk_merge%(handle1: opaque of topk, handle2: opaque of topk%): any
|
||||
%{
|
||||
|
|
@ -164,14 +164,14 @@ function topk_merge%(handle1: opaque of topk, handle2: opaque of topk%): any
|
|||
## data structure back to the size given on initialization.
|
||||
##
|
||||
## .. note:: Use with care and only when being aware of the restrictions this
|
||||
## entails. Do not call :bro:id:`topk_size` or :bro:id:`topk_add` afterwards,
|
||||
## entails. Do not call :zeek:id:`topk_size` or :zeek:id:`topk_add` afterwards,
|
||||
## results will probably not be what you expect.
|
||||
##
|
||||
## handle1: the TopK handle in which the second TopK structure is merged.
|
||||
##
|
||||
## handle2: the TopK handle in which is merged into the first TopK structure.
|
||||
##
|
||||
## .. bro:see:: topk_init topk_add topk_get_top topk_count topk_epsilon
|
||||
## .. zeek:see:: topk_init topk_add topk_get_top topk_count topk_epsilon
|
||||
## topk_size topk_sum topk_merge
|
||||
function topk_merge_prune%(handle1: opaque of topk, handle2: opaque of topk%): any
|
||||
%{
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue