forked from m3db/m3
-
Notifications
You must be signed in to change notification settings - Fork 0
/
types.go
139 lines (107 loc) · 4.05 KB
/
types.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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
// Copyright (c) 2016 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 cm
import "github.com/m3db/m3x/pool"
// Sample represents a sampled value.
type Sample struct {
value float64 // sampled value
numRanks int64 // number of ranks represented
delta int64 // delta between min rank and max rank
prev *Sample // previous sample
next *Sample // next sample
}
// SamplePool is a pool of samples.
type SamplePool interface {
// Init initializes the pool.
Init()
// Get returns a sample from the pool.
Get() *Sample
// Put returns a sample to the pool.
Put(sample *Sample)
}
// Stream represents a data sample stream for floating point numbers.
type Stream interface {
// Add adds a sample value.
Add(value float64)
// Flush flushes the internal buffer.
Flush()
// Min returns the minimum value.
Min() float64
// Max returns the maximum value.
Max() float64
// Quantile returns the quantile value.
Quantile(q float64) float64
// Close closes the stream.
Close()
// ResetSetData resets the stream and sets data.
ResetSetData(quantiles []float64)
}
// StreamAlloc allocates a stream.
type StreamAlloc func() Stream
// StreamPool provides a pool for streams.
type StreamPool interface {
// Init initializes the pool.
Init(alloc StreamAlloc)
// Get provides a stream from the pool.
Get() Stream
// Put returns a stream to the pool.
Put(value Stream)
}
// Options represent various options for computing quantiles.
type Options interface {
// SetEps sets the desired epsilon for errors.
SetEps(value float64) Options
// Eps returns the desired epsilon for errors.
Eps() float64
// SetCapacity sets the initial heap capacity.
SetCapacity(value int) Options
// Capacity returns the initial heap capacity.
Capacity() int
// SetInsertAndCompressEvery sets how frequently the timer values are
// inserted into the stream and compressed to reduce write latency for
// high frequency timers.
SetInsertAndCompressEvery(value int) Options
// InsertAndCompressEvery returns how frequently the timer values are
// inserted into the stream and compressed to reduce write latency for
// high frequency timers.
InsertAndCompressEvery() int
// SetFlushEvery sets how frequently the underlying stream is flushed
// to reduce processing time when computing aggregated statistics from
// the stream.
SetFlushEvery(value int) Options
// FlushEvery returns how frequently the underlying stream is flushed
// to reduce processing time when computing aggregated statistics from
// the stream.
FlushEvery() int
// SetStreamPool sets the stream pool.
SetStreamPool(value StreamPool) Options
// StreamPool returns the stream pool.
StreamPool() StreamPool
// SetSamplePool sets the sample pool.
SetSamplePool(value SamplePool) Options
// SamplePool returns the sample pool.
SamplePool() SamplePool
// SetFloatsPool sets the floats pool.
SetFloatsPool(value pool.FloatsPool) Options
// FloatsPool returns the floats pool.
FloatsPool() pool.FloatsPool
// Validate validates the options.
Validate() error
}