zeek/doc/scripts/base/frameworks/sumstats/plugins/average.zeek.rst
Tim Wojtulewicz ded98cd373 Copy docs into Zeek repo directly
This is based on commit 2731def9159247e6da8a3191783c89683363689c from the
zeek-docs repo.
2025-09-26 02:58:29 +00:00

32 lines
1.3 KiB
ReStructuredText

:tocdepth: 3
base/frameworks/sumstats/plugins/average.zeek
=============================================
.. zeek:namespace:: SumStats
Calculate the average.
:Namespace: SumStats
:Imports: :doc:`base/frameworks/sumstats/main.zeek </scripts/base/frameworks/sumstats/main.zeek>`
Summary
~~~~~~~
Redefinitions
#############
===================================================== ========================================================
:zeek:type:`SumStats::Calculation`: :zeek:type:`enum`
* :zeek:enum:`SumStats::AVERAGE`:
Calculate the average of the values.
:zeek:type:`SumStats::ResultVal`: :zeek:type:`record`
:New Fields: :zeek:type:`SumStats::ResultVal`
average: :zeek:type:`double` :zeek:attr:`&optional`
For numeric data, this is the average of all values.
===================================================== ========================================================
Detailed Interface
~~~~~~~~~~~~~~~~~~