-
Notifications
You must be signed in to change notification settings - Fork 535
/
distribution.rb
164 lines (160 loc) · 7.87 KB
/
distribution.rb
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# Copyright 2020 Google LLC
#
# Licensed 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
#
# https://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.
module Google
module Api
# `Distribution` contains summary statistics for a population of values. It
# optionally contains a histogram representing the distribution of those values
# across a set of buckets.
#
# The summary statistics are the count, mean, sum of the squared deviation from
# the mean, the minimum, and the maximum of the set of population of values.
# The histogram is based on a sequence of buckets and gives a count of values
# that fall into each bucket. The boundaries of the buckets are given either
# explicitly or by formulas for buckets of fixed or exponentially increasing
# widths.
#
# Although it is not forbidden, it is generally a bad idea to include
# non-finite values (infinities or NaNs) in the population of values, as this
# will render the `mean` and `sum_of_squared_deviation` fields meaningless.
# @!attribute [rw] count
# @return [Integer]
# The number of values in the population. Must be non-negative. This value
# must equal the sum of the values in `bucket_counts` if a histogram is
# provided.
# @!attribute [rw] mean
# @return [Float]
# The arithmetic mean of the values in the population. If `count` is zero
# then this field must be zero.
# @!attribute [rw] sum_of_squared_deviation
# @return [Float]
# The sum of squared deviations from the mean of the values in the
# population. For values x_i this is:
#
# Sum[i=1..n](https://cloud.google.com(x_i - mean)^2)
#
# Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition
# describes Welford's method for accumulating this sum in one pass.
#
# If `count` is zero then this field must be zero.
# @!attribute [rw] range
# @return [Google::Api::Distribution::Range]
# If specified, contains the range of the population values. The field
# must not be present if the `count` is zero.
# @!attribute [rw] bucket_options
# @return [Google::Api::Distribution::BucketOptions]
# Defines the histogram bucket boundaries. If the distribution does not
# contain a histogram, then omit this field.
# @!attribute [rw] bucket_counts
# @return [Array<Integer>]
# The number of values in each bucket of the histogram, as described in
# `bucket_options`. If the distribution does not have a histogram, then omit
# this field. If there is a histogram, then the sum of the values in
# `bucket_counts` must equal the value in the `count` field of the
# distribution.
#
# If present, `bucket_counts` should contain N values, where N is the number
# of buckets specified in `bucket_options`. If you supply fewer than N
# values, the remaining values are assumed to be 0.
#
# The order of the values in `bucket_counts` follows the bucket numbering
# schemes described for the three bucket types. The first value must be the
# count for the underflow bucket (number 0). The next N-2 values are the
# counts for the finite buckets (number 1 through N-2). The N'th value in
# `bucket_counts` is the count for the overflow bucket (number N-1).
# @!attribute [rw] exemplars
# @return [Array<Google::Api::Distribution::Exemplar>]
# Must be in increasing order of `value` field.
class Distribution
# `BucketOptions` describes the bucket boundaries used to create a histogram
# for the distribution. The buckets can be in a linear sequence, an
# exponential sequence, or each bucket can be specified explicitly.
# `BucketOptions` does not include the number of values in each bucket.
#
# A bucket has an inclusive lower bound and exclusive upper bound for the
# values that are counted for that bucket. The upper bound of a bucket must
# be strictly greater than the lower bound. The sequence of N buckets for a
# distribution consists of an underflow bucket (number 0), zero or more
# finite buckets (number 1 through N - 2) and an overflow bucket (number N -
# 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the
# same as the upper bound of bucket i - 1. The buckets span the whole range
# of finite values: lower bound of the underflow bucket is -infinity and the
# upper bound of the overflow bucket is +infinity. The finite buckets are
# so-called because both bounds are finite.
# @!attribute [rw] linear_buckets
# @return [Google::Api::Distribution::BucketOptions::Linear]
# The linear bucket.
# @!attribute [rw] exponential_buckets
# @return [Google::Api::Distribution::BucketOptions::Exponential]
# The exponential buckets.
# @!attribute [rw] explicit_buckets
# @return [Google::Api::Distribution::BucketOptions::Explicit]
# The explicit buckets.
class BucketOptions
# Specifies a linear sequence of buckets that all have the same width
# (except overflow and underflow). Each bucket represents a constant
# absolute uncertainty on the specific value in the bucket.
#
# There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the
# following boundaries:
#
# Upper bound (0 <= i < N-1): offset + (width * i).
# Lower bound (1 <= i < N): offset + (width * (i - 1)).
# @!attribute [rw] num_finite_buckets
# @return [Integer]
# Must be greater than 0.
# @!attribute [rw] width
# @return [Float]
# Must be greater than 0.
# @!attribute [rw] offset
# @return [Float]
# Lower bound of the first bucket.
class Linear; end
# Specifies an exponential sequence of buckets that have a width that is
# proportional to the value of the lower bound. Each bucket represents a
# constant relative uncertainty on a specific value in the bucket.
#
# There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the
# following boundaries:
#
# Upper bound (0 <= i < N-1): scale * (growth_factor ^ i).
# Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)).
# @!attribute [rw] num_finite_buckets
# @return [Integer]
# Must be greater than 0.
# @!attribute [rw] growth_factor
# @return [Float]
# Must be greater than 1.
# @!attribute [rw] scale
# @return [Float]
# Must be greater than 0.
class Exponential; end
# Specifies a set of buckets with arbitrary widths.
#
# There are `size(bounds) + 1` (= N) buckets. Bucket `i` has the following
# boundaries:
#
# Upper bound (0 <= i < N-1): bounds[i]
# Lower bound (1 <= i < N); bounds[i - 1]
#
# The `bounds` field must contain at least one element. If `bounds` has
# only one element, then there are no finite buckets, and that single
# element is the common boundary of the overflow and underflow buckets.
# @!attribute [rw] bounds
# @return [Array<Float>]
# The values must be monotonically increasing.
class Explicit; end
end
end
end
end