### window.avg

Supported in:

    window.avg(numeric_values [, should_ignore_zero_values])

#### Description

Returns the average of the input values (which can be Integers or Floats). Setting the optional second argument to true ignores zero values.

#### Param data types

`INT|FLOAT`

#### Return type

`FLOAT`

#### Code samples

##### Example 1

This example shows the integer average.

    // This rule sets the outcome $size_mode to the average
    // file size in the 5 minute match window.
    events:
     $e.user.userid = $userid
    match:
     $userid over 5m
    outcome:
      $size_mode = window.avg($e.file.size) // yields 2.5 if the event file size values in the match window are 1, 2, 3 and 4

##### Example 2

This example shows the float average.

    events:
     $e.user.userid = $userid
    match:
     $userid over 5m
    outcome:
      $size_mode = window.avg($e.file.size) // yields 1.75 if the event file size values in the match window are 1.1 and 2.4

##### Example 3

Negative input average

    events:
     $e.user.userid = $userid
    match:
     $userid over 5m
    outcome:
      $size_mode = window.avg($e.file.size) // yields 0.6 if the event file size values in the match window are -1.1, 1.1, 0.0 and 2.4

##### Example 4

0 returns 0

    events:
     $e.user.userid = $userid
    match:
     $userid over 5m
    outcome:
      $size_mode = window.avg($e.file.size) // yields 0 if the event file size values in the match window is 0

##### Example 5

Ignoring 0 values

    events:
     $e.user.userid = $userid
    match:
     $userid over 5m
    outcome:
      $size_mode = window.avg($e.file.size, true) // yields 394 if the event file size values in the match window are 0, 0, 0 and 394