1. class
  2. Google
  3. \
  4. Api
  5. \
  6. Distribution

Distribution

class Distribution extends Message

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

Methods

__construct(array $data = NULL)

Constructor.

int|string
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.

$this
setCount(int|string $var)

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.

float
getMean()

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

$this
setMean(float $var)

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

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.

$this
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.

Range
getRange()

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

$this
setRange(Range $var)

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

BucketOptions
getBucketOptions()

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

$this
setBucketOptions(BucketOptions $var)

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

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

$this
setBucketCounts(int[]|string[]|RepeatedField $var)

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.

RepeatedField
getExemplars()

Must be in increasing order of value field.

$this
setExemplars(Exemplar[]|RepeatedField $var)

Must be in increasing order of value field.

Details

at line 138
__construct(array $data = NULL)

Constructor.

Parameters

array $data { Optional. Data for populating the Message object.

@type int|string $count
      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.
@type float $mean
      The arithmetic mean of the values in the population. If `count` is zero
      then this field must be zero.
@type float $sum_of_squared_deviation
      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.
@type \Google\Api\Distribution\Range $range
      If specified, contains the range of the population values. The field
      must not be present if the `count` is zero.
@type \Google\Api\Distribution\BucketOptions $bucket_options
      Defines the histogram bucket boundaries. If the distribution does not
      contain a histogram, then omit this field.
@type int[]|string[]|\Google\Protobuf\Internal\RepeatedField $bucket_counts
      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).
@type \Google\Api\Distribution\Exemplar[]|\Google\Protobuf\Internal\RepeatedField $exemplars
      Must be in increasing order of `value` field.

}

at line 151
int|string 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.

Generated from protobuf field int64 count = 1;

Return Value

int|string

at line 165
$this setCount(int|string $var)

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.

Generated from protobuf field int64 count = 1;

Parameters

int|string $var

Return Value

$this

at line 180
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;

Return Value

float

at line 193
$this 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;

Parameters

float $var

Return Value

$this

at line 212
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;

Return Value

float

at line 229
$this 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;

Parameters

float $var

Return Value

$this

at line 244
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;

Return Value

Range

at line 257
$this setRange(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;

Parameters

Range $var

Return Value

$this

at line 272
BucketOptions getBucketOptions()

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

Generated from protobuf field .google.api.Distribution.BucketOptions bucket_options = 6;

Return Value

BucketOptions

at line 285
$this setBucketOptions(BucketOptions $var)

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

Generated from protobuf field .google.api.Distribution.BucketOptions bucket_options = 6;

Parameters

BucketOptions $var

Return Value

$this

at line 311
RepeatedField 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).

Generated from protobuf field repeated int64 bucket_counts = 7;

Return Value

RepeatedField

at line 335
$this setBucketCounts(int[]|string[]|RepeatedField $var)

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

Generated from protobuf field repeated int64 bucket_counts = 7;

Parameters

int[]|string[]|RepeatedField $var

Return Value

$this

at line 349
RepeatedField getExemplars()

Must be in increasing order of value field.

Generated from protobuf field repeated .google.api.Distribution.Exemplar exemplars = 10;

Return Value

RepeatedField

at line 361
$this setExemplars(Exemplar[]|RepeatedField $var)

Must be in increasing order of value field.

Generated from protobuf field repeated .google.api.Distribution.Exemplar exemplars = 10;

Parameters

Exemplar[]|RepeatedField $var

Return Value

$this