PHPFUI/InstaDoc
 
Copied!

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

CloneableInstantiable
Methods
public __construct( $data = NULL)
 

Constructor.

  • param 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 232, 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 array<int>|array<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 array<\Google\Api\Distribution\Exemplar>|\Google\Protobuf\Internal\RepeatedField $exemplars
      Must be in increasing order of `value` field.
    }
public Google\Protobuf\Internal\Message::__debugInfo()
public Google\Protobuf\Internal\Message::byteSize()
 
  • ignore
public Google\Protobuf\Internal\Message::clear()
 

Clear all containing fields.

  • return null
public clearBucketOptions()
public clearRange()
public Google\Protobuf\Internal\Message::discardUnknownFields()
 

Clear all unknown fields previously parsed.

  • return null
public 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 \Google\Protobuf\Internal\RepeatedField
public 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 \Google\Api\Distribution\BucketOptions|null
public 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 int|string
public getExemplars()
 

Must be in increasing order of value field.

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

  • return \Google\Protobuf\Internal\RepeatedField
public 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 float
public 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 \Google\Api\Distribution\Range|null
public 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.

Generated from protobuf field double sum_of_squared_deviation = 3;

  • return float
public hasBucketOptions()
public hasRange()
public Google\Protobuf\Internal\Message::jsonByteSize( $options = 0)
 
  • ignore
public Google\Protobuf\Internal\Message::mergeFrom( $msg)
 

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Map fields key-value pairs are overwritten. Singular/Oneof sub-messages are recursively merged. All overwritten sub-messages are deep-copied.

  • param object $msg Protobuf message to be merged from.
  • return null
public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)
 

Parses a json string to protobuf message.

This function takes a string in the json wire format, matching the encoding output by serializeToJsonString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

  • param string $data Json protobuf data.
  • param bool $ignore_unknown
  • return null
  • throws \Exception Invalid data.
public Google\Protobuf\Internal\Message::mergeFromString( $data)
 

Parses a protocol buffer contained in a string.

This function takes a string in the (non-human-readable) binary wire format, matching the encoding output by serializeToString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

  • param string $data Binary protobuf data.
  • return null
  • throws \Exception Invalid data.
public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)
 
  • ignore
public Google\Protobuf\Internal\Message::parseFromStream( $input)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToJsonString( $options = 0)
 

Serialize the message to json string.

  • return string Serialized json protobuf data.
public Google\Protobuf\Internal\Message::serializeToStream( $output)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToString()
 

Serialize the message to string.

  • return string Serialized binary protobuf data.
public setBucketCounts( $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;

  • param int[]|string[]|\Google\Protobuf\Internal\RepeatedField $var
  • return $this
public setBucketOptions( $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;

  • param \Google\Api\Distribution\BucketOptions $var
  • return $this
public setCount( $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;

  • param int|string $var
  • return $this
public setExemplars( $var)
 

Must be in increasing order of value field.

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

  • param \Google\Api\Distribution\Exemplar[]|\Google\Protobuf\Internal\RepeatedField $var
  • return $this
public setMean( $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;

  • param float $var
  • return $this
public setRange( $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;

  • param \Google\Api\Distribution\Range $var
  • return $this
public setSumOfSquaredDeviation( $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 232, 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;

  • param float $var
  • return $this
Properties
protected $bucket_options = NULL
 

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;

protected $count = 0
 

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;

protected $mean = 0
 

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;

protected $range = NULL
 

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;

protected $sum_of_squared_deviation = 0
 

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.

Generated from protobuf field double sum_of_squared_deviation = 3;

Methods
protected Google\Protobuf\Internal\Message::hasOneof( $number)
protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)
 

Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.

Example:

$message->mergeFromArray([
    'name' => 'This is a message name',
    'interval' => [
         'startTime' => time() - 60,
         'endTime' => time(),
    ]
]);

This method will trigger an error if it is passed data that cannot be converted to the correct type. For example, a StringValue field must receive data that is either a string or a StringValue object.

  • param array $array An array containing message properties and values.
  • return null
protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)
protected Google\Protobuf\Internal\Message::readOneof( $number)
protected Google\Protobuf\Internal\Message::readWrapperValue( $member)
protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)
protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)
protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)
Properties
private $bucket_counts = NULL
 

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;

private $exemplars = NULL
 

Must be in increasing order of value field.

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

© 2025 Bruce Wells
Search Namespaces \ Classes
Configuration