Google API Common Protos Client - Class Distribution (4.8.3)

Version latest

• 4.8.3 (latest)
• 4.8.2

Reference documentation and code samples for the Google API Common Protos Client class Distribution.

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.

Generated from protobuf message google.api.Distribution

Namespace

Google \ Api

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ count	int|string 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.
↳ mean	float The arithmetic mean of the values in the population. If count is zero then this field must be zero.
↳ sum_of_squared_deviation	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]((x_i - mean)^2) Knuth, "The Art of Computer Programming", Vol. 2, page 232, 3rd edition describes Welford's method for accumulating this sum in one pass. If count is zero then this field must be zero.
↳ range	Google\Api\Distribution\Range If specified, contains the range of the population values. The field must not be present if the count is zero.
↳ bucket_options	Google\Api\Distribution\BucketOptions Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field.
↳ bucket_counts	array 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).
↳ exemplars	array<Google\Api\Distribution\Exemplar> Must be in increasing order of value field.

getCount

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.

Returns
Type	Description
int|string

setCount

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.

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getMean

The arithmetic mean of the values in the population. If count is zero then this field must be zero.

Returns
Type	Description
float

setMean

The arithmetic mean of the values in the population. If count is zero then this field must be zero.

Parameter
Name	Description
var	float

Returns
Type	Description
$this

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 232, 3rd edition describes Welford's method for accumulating this sum in one pass.

If count is zero then this field must be zero.

Returns
Type	Description
float

setSumOfSquaredDeviation

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 232, 3rd edition describes Welford's method for accumulating this sum in one pass.

If count is zero then this field must be zero.

Parameter
Name	Description
var	float

Returns
Type	Description
$this

getRange

If specified, contains the range of the population values. The field must not be present if the count is zero.

Returns
Type	Description
Google\Api\Distribution\Range|null

hasRange

clearRange

setRange

If specified, contains the range of the population values. The field must not be present if the count is zero.

Parameter
Name	Description
var	Google\Api\Distribution\Range

Returns
Type	Description
$this

getBucketOptions

Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field.

Returns
Type	Description
Google\Api\Distribution\BucketOptions|null

hasBucketOptions

clearBucketOptions

setBucketOptions

Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field.

Parameter
Name	Description
var	Google\Api\Distribution\BucketOptions

Returns
Type	Description
$this

getBucketCounts

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).

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setBucketCounts

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).

Parameter
Name	Description
var	int[]|string[]|Google\Protobuf\Internal\RepeatedField

Returns
Type	Description
$this

getExemplars

Must be in increasing order of value field.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setExemplars

Must be in increasing order of value field.

Parameter
Name	Description
var	array<Google\Api\Distribution\Exemplar>

Returns
Type	Description
$this