## Documentation

### Overview ¶

Package stats contains transforms for statistical processing.

### Constants ¶

This section is empty.

### Variables ¶

This section is empty.

### Functions ¶

#### func Count¶

`func Count(s beam.Scope, col beam.PCollection) beam.PCollection`

Count counts the number of appearances of each element in a collection. It expects a PCollection<T> as input and returns a PCollection<KV<T,int>>. T's encoding must be deterministic so it is valid as a key.

#### func CountElms¶

`func CountElms(s beam.Scope, col beam.PCollection) beam.PCollection`

CountElms counts the number of elements in a collection. It expects a PCollection<T> as input and returns a PCollection<int> of one element containing the count.

#### func Max¶

`func Max(s beam.Scope, col beam.PCollection) beam.PCollection`

Max returns the maximal element in a PCollection<A> as a singleton PCollection<A>. It can only be used for numbers, such as int, uint16, float32, etc.

For example:

```col := beam.Create(s, 1, 11, 7, 5, 10)
max := stats.Max(s, col)   // PCollection<int> with 11 as the only element.
```

#### func MaxPerKey¶

`func MaxPerKey(s beam.Scope, col beam.PCollection) beam.PCollection`

MaxPerKey returns the maximal element per key in a PCollection<KV<A,B>> as a PCollection<KV<A,B>>. It can only be used for numbers, such as int, uint16, float32, etc.

#### func Mean¶

`func Mean(s beam.Scope, col beam.PCollection) beam.PCollection`

Mean returns the arithmetic mean (or average) of the elements in a collection. It expects a PCollection<A> as input and returns a singleton PCollection<float64>. It can only be used for numbers, such as int, uint16, float32, etc.

For example:

```col := beam.Create(s, 1, 11, 7, 5, 10)
mean := stats.Mean(s, col)   // PCollection<float64> with 6.8 as the only element.
```

#### func MeanPerKey¶

`func MeanPerKey(s beam.Scope, col beam.PCollection) beam.PCollection`

MeanPerKey returns the arithmetic mean (or average) for each key of the elements in a collection. It expects a PCollection<KV<A,B>> as input and returns a PCollection<KV<A,float64>>. It can only be used for numbers, such as int, uint16, float32, etc.

#### func Min¶

`func Min(s beam.Scope, col beam.PCollection) beam.PCollection`

Min returns the minimal element in a PCollection<A> as a singleton PCollection<A>. It can only be used for numbers, such as int, uint16, float32, etc.

For example:

```col := beam.Create(s, 1, 11, 7, 5, 10)
min := stats.Min(s, col)   // PCollection<int> with 1 as the only element.
```

#### func MinPerKey¶

`func MinPerKey(s beam.Scope, col beam.PCollection) beam.PCollection`

MinPerKey returns the minimal element per key in a PCollection<KV<A,B>> as a PCollection<KV<A,B>>. It can only be used for numbers, such as int, uint16, float32, etc.

#### func Sum¶

`func Sum(s beam.Scope, col beam.PCollection) beam.PCollection`

Sum returns the sum of the elements in a PCollection<A> as a singleton PCollection<A>. It can only be used for numbers, such as int, uint16, float32, etc.

For example:

```col := beam.Create(s, 1, 11, 7, 5, 10)
sum := stats.Sum(s, col)   // PCollection<int> with 34 as the only element.
```

#### func SumPerKey¶

`func SumPerKey(s beam.Scope, col beam.PCollection) beam.PCollection`

SumPerKey returns the sum of the values per key in a PCollection<KV<A,B>> as a PCollection<KV<A,B>>. It can only be used for value numbers, such as int, uint16, float32, etc.

### Types ¶

This section is empty.