Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt
hiddentrue

Siddhi Inbuilt Aggregate Functions in wiki format

...

Syntax<long|double> sum(<int|long|double|float> arg)
Extension TypeAggregate Function
DescriptionCalculates the sum for all the events.
ParameterThe value that needs to be summed.
Return TypeReturns long if the input parameter type is int or long, and returns double if the input parameter type is float or double.
Examples
  • sum(20) returns the sum of 20s as a long value for each event arrival and expiry. sum(temp) returns the sum of all temp attributes based on each event arrival and expiry. 

<long|double> sum(<int|long|double|float> arg)

...

  • sum(

...

  • temp) returns the sum of all temp attributes based on each event arrival and expiry.

avg
Anchor
avg
avg

Syntax 
Extension Type 
Description 
Parameter 
Return Type 
Examples

...

<double> avg(<int|long|double|

...

float> arg)
Extension Type

...

Aggregate Function
Description

...

Calculates the average for all the events.
Parameter

...

arg: The value that need to be averaged.
Return Type

...

Returns the calculated average value as a double.
Example

...

avg(temp) returns the average temp value for all the events based on their arrival and expiry.

max
Anchor
max
max

Syntax 
Extension Type 
Description 
Parameter 
Return Type 
Examples
<int|long|double|

...

float> max(<int|long|double|

...

float> arg)
Extension Type

...

Aggregate Function
Description

...

Returns the

...

maximum value for all the events.
Parameter

...

arg: The value that

...

needs to be compared to find the

...

maximum value.
Return Type

...

Returns

...

the maximum value in the same data type as the input.

...

Examplemax(temp) returns the maximum temp value recorded for all the events based on their arrival and expiry.

min
Anchor
min
min

...

 

Extension Type 
Description 
Parameter 
Return Type 
Examples
Syntax<int|long|double|

...

float> min(<int|long|double|

...

float> arg)
Extension Type

...

Aggregate Function
Description

...

Returns the

...

minimum value for all the events.
Parameter

...

arg: The value that

...

needs to be compared to find the

...

minimum value.
Return Type

...

Returns

...

the minimum value in the same type as the input.
Example

...

min(temp) returns the minimum temp value recorded for all the events based on their arrival and expiry.

count
Anchor
count
count

 
Syntax 
Extension Type 
Description 
Parameter
Return Type 
Examples
<long> count()
Extension Type

...

Aggregate Function
Description

...

Returns the count of all the events.
Return Type

...

Returns the event count as a long.
Example

...

count()

...

returns the count of all the events.

stddev
Anchor
stddev
stddev

Syntax 
Extension Type 
Description 
Parameter 
Return Type 
Examples

...

<double> stddev(<int|long|double|

...

float> arg)
Extension Type

...

Aggregate Function
Description

...

Returns the calculated standard deviation for all the events.
Parameter

...

arg: The value that should be used

...

to calculate the standard deviation.
Return Type

...

Returns the calculated standard deviation value as a double.
Example

...

stddev(temp) returns the calculated standard deviation of temp

...

for all the events based on their arrival and expiry.

...

Excerpt
hiddentrue

average

Todo add other aggregate functions

...