Distribution
class Distribution extends Message
Distribution contains summary statistics for a population of values and, optionally, a histogram representing the distribution of those values across a specified set of histogram 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 specifying parameters for a method of computing them
(buckets of fixed width or buckets of exponentially increasing width).
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.
Protobuf type Google\Api\Distribution
Methods
No description
The number of values in the population. Must be non-negative.
The number of values in the population. Must be non-negative.
The arithmetic mean of the values in the population. If count is zero
then this field must be zero.
The arithmetic mean of the values in the population. If count is zero
then this field must be zero.
The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1.
The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1.
If specified, contains the range of the population values. The field
must not be present if the count is zero.
If specified, contains the range of the population values. The field
must not be present if the count is zero.
Defines the histogram bucket boundaries.
If bucket_options is given, then the sum of the values in bucket_counts
must equal the value in count. If bucket_options is not given, no
bucket_counts fields may be given.
If bucket_options is given, then the sum of the values in bucket_counts
must equal the value in count. If bucket_options is not given, no
bucket_counts fields may be given.
Details
at line 81
__construct()
at line 92
int|string
getCount()
The number of values in the population. Must be non-negative.
Generated from protobuf field int64 count = 1;
at line 103
setCount(int|string $var)
The number of values in the population. Must be non-negative.
Generated from protobuf field int64 count = 1;
at line 116
float
getMean()
The arithmetic mean of the values in the population. If count is zero
then this field must be zero.
Generated from protobuf field double mean = 2;
at line 128
setMean(float $var)
The arithmetic mean of the values in the population. If count is zero
then this field must be zero.
Generated from protobuf field double mean = 2;
at line 145
float
getSumOfSquaredDeviation()
The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1.
.n]((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.
Generated from protobuf field double sum_of_squared_deviation = 3;
at line 161
setSumOfSquaredDeviation(float $var)
The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1.
.n]((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.
Generated from protobuf field double sum_of_squared_deviation = 3;
at line 174
Distribution_Range
getRange()
If specified, contains the range of the population values. The field
must not be present if the count is zero.
Generated from protobuf field .google.api.Distribution.Range range = 4;
at line 186
setRange(Distribution_Range $var)
If specified, contains the range of the population values. The field
must not be present if the count is zero.
Generated from protobuf field .google.api.Distribution.Range range = 4;
at line 198
Distribution_BucketOptions
getBucketOptions()
Defines the histogram bucket boundaries.
Generated from protobuf field .google.api.Distribution.BucketOptions bucket_options = 6;
at line 209
setBucketOptions(Distribution_BucketOptions $var)
Defines the histogram bucket boundaries.
Generated from protobuf field .google.api.Distribution.BucketOptions bucket_options = 6;
at line 229
RepeatedField
getBucketCounts()
If bucket_options is given, then the sum of the values in bucket_counts
must equal the value in count. If bucket_options is not given, no
bucket_counts fields may be given.
Bucket counts are given in order under the numbering scheme described
above (the underflow bucket has number 0; the finite buckets, if any,
have numbers 1 through N-2; the overflow bucket has number N-1).
The size of bucket_counts must be no greater than N as defined in
bucket_options.
Any suffix of trailing zero bucket_count fields may be omitted.
Generated from protobuf field repeated int64 bucket_counts = 7;
at line 248
setBucketCounts(array|RepeatedField $var)
If bucket_options is given, then the sum of the values in bucket_counts
must equal the value in count. If bucket_options is not given, no
bucket_counts fields may be given.
Bucket counts are given in order under the numbering scheme described
above (the underflow bucket has number 0; the finite buckets, if any,
have numbers 1 through N-2; the overflow bucket has number N-1).
The size of bucket_counts must be no greater than N as defined in
bucket_options.
Any suffix of trailing zero bucket_count fields may be omitted.
Generated from protobuf field repeated int64 bucket_counts = 7;