google.api.Distribution
*/
class Distribution extends \Google\Protobuf\Internal\Message
{
/**
* The number of values in the population. Must be non-negative.
*
* Generated from protobuf field int64 count = 1;
*/
private $count = 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;
*/
private $mean = 0.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 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;
*/
private $sum_of_squared_deviation = 0.0;
/**
* 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;
*/
private $range = null;
/**
* Defines the histogram bucket boundaries.
*
* Generated from protobuf field .google.api.Distribution.BucketOptions bucket_options = 6;
*/
private $bucket_options = null;
/**
* 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;
*/
private $bucket_counts;
/**
* 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.
* @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.
* @type int[]|string[]|\Google\Protobuf\Internal\RepeatedField $bucket_counts
* 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.
* }
*/
public function __construct($data = NULL) {
\GPBMetadata\Google\Api\Distribution::initOnce();
parent::__construct($data);
}
/**
* The number of values in the population. Must be non-negative.
*
* Generated from protobuf field int64 count = 1;
* @return int|string
*/
public function getCount()
{
return $this->count;
}
/**
* The number of values in the population. Must be non-negative.
*
* Generated from protobuf field int64 count = 1;
* @param int|string $var
* @return $this
*/
public function setCount($var)
{
GPBUtil::checkInt64($var);
$this->count = $var;
return $this;
}
/**
* 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 function getMean()
{
return $this->mean;
}
/**
* 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 function setMean($var)
{
GPBUtil::checkDouble($var);
$this->mean = $var;
return $this;
}
/**
* 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 float
*/
public function getSumOfSquaredDeviation()
{
return $this->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.
*
* Generated from protobuf field double sum_of_squared_deviation = 3;
* @param float $var
* @return $this
*/
public function setSumOfSquaredDeviation($var)
{
GPBUtil::checkDouble($var);
$this->sum_of_squared_deviation = $var;
return $this;
}
/**
* 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
*/
public function getRange()
{
return $this->range;
}
/**
* 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 function setRange($var)
{
GPBUtil::checkMessage($var, \Google\Api\Distribution_Range::class);
$this->range = $var;
return $this;
}
/**
* Defines the histogram bucket boundaries.
*
* Generated from protobuf field .google.api.Distribution.BucketOptions bucket_options = 6;
* @return \Google\Api\Distribution\BucketOptions
*/
public function getBucketOptions()
{
return $this->bucket_options;
}
/**
* Defines the histogram bucket boundaries.
*
* Generated from protobuf field .google.api.Distribution.BucketOptions bucket_options = 6;
* @param \Google\Api\Distribution\BucketOptions $var
* @return $this
*/
public function setBucketOptions($var)
{
GPBUtil::checkMessage($var, \Google\Api\Distribution_BucketOptions::class);
$this->bucket_options = $var;
return $this;
}
/**
* 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;
* @return \Google\Protobuf\Internal\RepeatedField
*/
public function getBucketCounts()
{
return $this->bucket_counts;
}
/**
* 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;
* @param int[]|string[]|\Google\Protobuf\Internal\RepeatedField $var
* @return $this
*/
public function setBucketCounts($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::INT64);
$this->bucket_counts = $arr;
return $this;
}
}