/
mean.go
86 lines (70 loc) · 2.78 KB
/
mean.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
// Licensed to the Apache Software Foundation (ASF) under one or more
// contributor license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright ownership.
// The ASF licenses this file to You under the Apache License, Version 2.0
// (the "License"); you may not use this file except in compliance with
// the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package stats
import (
"reflect"
"github.com/apache/beam/sdks/v2/go/pkg/beam"
"github.com/apache/beam/sdks/v2/go/pkg/beam/core/util/reflectx"
)
// 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 Mean(s beam.Scope, col beam.PCollection) beam.PCollection {
s = s.Scope("stats.Mean")
t := beam.ValidateNonCompositeType(col)
validateNonComplexNumber(t.Type())
return beam.Combine(s, &meanFn{}, col)
}
// 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 MeanPerKey(s beam.Scope, col beam.PCollection) beam.PCollection {
s = s.Scope("stats.MeanPerKey")
_, t := beam.ValidateKVType(col)
validateNonComplexNumber(t.Type())
return beam.CombinePerKey(s, &meanFn{}, col)
}
// TODO(herohde) 7/7/2017: the accumulator should be serializable with a Coder.
type meanAccum struct {
Count int64
Sum float64
}
// meanFn is a combineFn that accumulates the count and sum of numbers to
// produce their mean. It assumes numbers are convertible to float64.
type meanFn struct{}
func (f *meanFn) CreateAccumulator() meanAccum {
return meanAccum{}
}
func (f *meanFn) AddInput(a meanAccum, val beam.T) meanAccum {
a.Count++
a.Sum += reflect.ValueOf(val.(interface{})).Convert(reflectx.Float64).Interface().(float64)
return a
}
func (f *meanFn) MergeAccumulators(a, b meanAccum) meanAccum {
return meanAccum{Count: a.Count + b.Count, Sum: a.Sum + b.Sum}
}
func (f *meanFn) ExtractOutput(a meanAccum) float64 {
if a.Count == 0 {
return 0
}
return a.Sum / float64(a.Count)
}