forked from m3db/m3
/
aggregate_values.go
94 lines (80 loc) · 2.86 KB
/
aggregate_values.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
87
88
89
90
91
92
93
94
// Copyright (c) 2019 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package index
import (
"errors"
"github.com/m3db/m3/src/x/ident"
"github.com/m3db/m3/src/x/pool"
)
var (
errUnableToAddValueMissingID = errors.New("no id for value")
)
// AggregateValues is a collection of unique identity values backed by a pool.
// NB: there are no synchronization guarantees provided by default.
type AggregateValues struct {
valuesMap *AggregateValuesMap
bytesPool pool.CheckedBytesPool
pool AggregateValuesPool
}
// NewAggregateValues returns a new AggregateValues object.
func NewAggregateValues(opts Options) AggregateValues {
return AggregateValues{
valuesMap: NewAggregateValuesMap(opts.IdentifierPool()),
bytesPool: opts.CheckedBytesPool(),
pool: opts.AggregateValuesPool(),
}
}
// MustNewAggregateValues returns a new AggregateValues object with provided
// idents added in.
func MustNewAggregateValues(opts Options, ids ...ident.ID) AggregateValues {
m := NewAggregateValues(opts)
for _, id := range ids {
if err := m.addValue(id); err != nil {
panic(err.Error())
}
}
return m
}
// Map returns a map from an ID -> empty struct to signify existence of the
// ID in the set this structure represents.
func (v *AggregateValues) Map() *AggregateValuesMap {
return v.valuesMap
}
// Size returns the number of IDs tracked.
func (v *AggregateValues) Size() int {
return v.valuesMap.Len()
}
func (v *AggregateValues) finalize() {
// NB: resetting the value map will already finalize all copies of the keys.
v.valuesMap.Reset()
if v.pool == nil {
return
}
v.pool.Put(*v)
}
func (v *AggregateValues) addValue(value ident.ID) error {
bytesID := ident.BytesID(value.Bytes())
if len(bytesID) == 0 {
return errUnableToAddValueMissingID
}
// NB: fine to overwrite the values here.
v.valuesMap.Set(bytesID, struct{}{})
return nil
}