Distribution.php — ShareThis Dashboard for Google Analytics trunk

googleanalytics / lib / analytics-admin / vendor / google / common-protos / src / Api / Distribution.php

googleanalytics / lib / analytics-admin / vendor / google / common-protos / src / Api Last commit date

Distribution.php

371 lines

1	<?php
2	# Generated by the protocol buffer compiler. DO NOT EDIT!
3	# source: google/api/distribution.proto
4
5	namespace Google\Api;
6
7	use Google\Protobuf\Internal\GPBType;
8	use Google\Protobuf\Internal\RepeatedField;
9	use Google\Protobuf\Internal\GPBUtil;
10
11	/**
12	* `Distribution` contains summary statistics for a population of values. It
13	* optionally contains a histogram representing the distribution of those values
14	* across a set of buckets.
15	* The summary statistics are the count, mean, sum of the squared deviation from
16	* the mean, the minimum, and the maximum of the set of population of values.
17	* The histogram is based on a sequence of buckets and gives a count of values
18	* that fall into each bucket. The boundaries of the buckets are given either
19	* explicitly or by formulas for buckets of fixed or exponentially increasing
20	* widths.
21	* Although it is not forbidden, it is generally a bad idea to include
22	* non-finite values (infinities or NaNs) in the population of values, as this
23	* will render the `mean` and `sum_of_squared_deviation` fields meaningless.
24	*
25	* Generated from protobuf message <code>google.api.Distribution</code>
26	*/
27	class Distribution extends \Google\Protobuf\Internal\Message
28	{
29	/**
30	* The number of values in the population. Must be non-negative. This value
31	* must equal the sum of the values in `bucket_counts` if a histogram is
32	* provided.
33	*
34	* Generated from protobuf field <code>int64 count = 1;</code>
35	*/
36	private $count = 0;
37	/**
38	* The arithmetic mean of the values in the population. If `count` is zero
39	* then this field must be zero.
40	*
41	* Generated from protobuf field <code>double mean = 2;</code>
42	*/
43	private $mean = 0.0;
44	/**
45	* The sum of squared deviations from the mean of the values in the
46	* population. For values x_i this is:
47	* Sum[i=1..n]((x_i - mean)^2)
48	* Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition
49	* describes Welford's method for accumulating this sum in one pass.
50	* If `count` is zero then this field must be zero.
51	*
52	* Generated from protobuf field <code>double sum_of_squared_deviation = 3;</code>
53	*/
54	private $sum_of_squared_deviation = 0.0;
55	/**
56	* If specified, contains the range of the population values. The field
57	* must not be present if the `count` is zero.
58	*
59	* Generated from protobuf field <code>.google.api.Distribution.Range range = 4;</code>
60	*/
61	private $range = null;
62	/**
63	* Defines the histogram bucket boundaries. If the distribution does not
64	* contain a histogram, then omit this field.
65	*
66	* Generated from protobuf field <code>.google.api.Distribution.BucketOptions bucket_options = 6;</code>
67	*/
68	private $bucket_options = null;
69	/**
70	* The number of values in each bucket of the histogram, as described in
71	* `bucket_options`. If the distribution does not have a histogram, then omit
72	* this field. If there is a histogram, then the sum of the values in
73	* `bucket_counts` must equal the value in the `count` field of the
74	* distribution.
75	* If present, `bucket_counts` should contain N values, where N is the number
76	* of buckets specified in `bucket_options`. If you supply fewer than N
77	* values, the remaining values are assumed to be 0.
78	* The order of the values in `bucket_counts` follows the bucket numbering
79	* schemes described for the three bucket types. The first value must be the
80	* count for the underflow bucket (number 0). The next N-2 values are the
81	* counts for the finite buckets (number 1 through N-2). The N'th value in
82	* `bucket_counts` is the count for the overflow bucket (number N-1).
83	*
84	* Generated from protobuf field <code>repeated int64 bucket_counts = 7;</code>
85	*/
86	private $bucket_counts;
87	/**
88	* Must be in increasing order of `value` field.
89	*
90	* Generated from protobuf field <code>repeated .google.api.Distribution.Exemplar exemplars = 10;</code>
91	*/
92	private $exemplars;
93
94	/**
95	* Constructor.
96	*
97	* @param array $data {
98	* Optional. Data for populating the Message object.
99	*
100	* @type int\|string $count
101	* The number of values in the population. Must be non-negative. This value
102	* must equal the sum of the values in `bucket_counts` if a histogram is
103	* provided.
104	* @type float $mean
105	* The arithmetic mean of the values in the population. If `count` is zero
106	* then this field must be zero.
107	* @type float $sum_of_squared_deviation
108	* The sum of squared deviations from the mean of the values in the
109	* population. For values x_i this is:
110	* Sum[i=1..n]((x_i - mean)^2)
111	* Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition
112	* describes Welford's method for accumulating this sum in one pass.
113	* If `count` is zero then this field must be zero.
114	* @type \Google\Api\Distribution\Range $range
115	* If specified, contains the range of the population values. The field
116	* must not be present if the `count` is zero.
117	* @type \Google\Api\Distribution\BucketOptions $bucket_options
118	* Defines the histogram bucket boundaries. If the distribution does not
119	* contain a histogram, then omit this field.
120	* @type int[]\|string[]\|\Google\Protobuf\Internal\RepeatedField $bucket_counts
121	* The number of values in each bucket of the histogram, as described in
122	* `bucket_options`. If the distribution does not have a histogram, then omit
123	* this field. If there is a histogram, then the sum of the values in
124	* `bucket_counts` must equal the value in the `count` field of the
125	* distribution.
126	* If present, `bucket_counts` should contain N values, where N is the number
127	* of buckets specified in `bucket_options`. If you supply fewer than N
128	* values, the remaining values are assumed to be 0.
129	* The order of the values in `bucket_counts` follows the bucket numbering
130	* schemes described for the three bucket types. The first value must be the
131	* count for the underflow bucket (number 0). The next N-2 values are the
132	* counts for the finite buckets (number 1 through N-2). The N'th value in
133	* `bucket_counts` is the count for the overflow bucket (number N-1).
134	* @type \Google\Api\Distribution\Exemplar[]\|\Google\Protobuf\Internal\RepeatedField $exemplars
135	* Must be in increasing order of `value` field.
136	* }
137	*/
138	public function __construct($data = NULL) {
139	\GPBMetadata\Google\Api\Distribution::initOnce();
140	parent::__construct($data);
141	}
142
143	/**
144	* The number of values in the population. Must be non-negative. This value
145	* must equal the sum of the values in `bucket_counts` if a histogram is
146	* provided.
147	*
148	* Generated from protobuf field <code>int64 count = 1;</code>
149	* @return int\|string
150	*/
151	public function getCount()
152	{
153	return $this->count;
154	}
155
156	/**
157	* The number of values in the population. Must be non-negative. This value
158	* must equal the sum of the values in `bucket_counts` if a histogram is
159	* provided.
160	*
161	* Generated from protobuf field <code>int64 count = 1;</code>
162	* @param int\|string $var
163	* @return $this
164	*/
165	public function setCount($var)
166	{
167	GPBUtil::checkInt64($var);
168	$this->count = $var;
169
170	return $this;
171	}
172
173	/**
174	* The arithmetic mean of the values in the population. If `count` is zero
175	* then this field must be zero.
176	*
177	* Generated from protobuf field <code>double mean = 2;</code>
178	* @return float
179	*/
180	public function getMean()
181	{
182	return $this->mean;
183	}
184
185	/**
186	* The arithmetic mean of the values in the population. If `count` is zero
187	* then this field must be zero.
188	*
189	* Generated from protobuf field <code>double mean = 2;</code>
190	* @param float $var
191	* @return $this
192	*/
193	public function setMean($var)
194	{
195	GPBUtil::checkDouble($var);
196	$this->mean = $var;
197
198	return $this;
199	}
200
201	/**
202	* The sum of squared deviations from the mean of the values in the
203	* population. For values x_i this is:
204	* Sum[i=1..n]((x_i - mean)^2)
205	* Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition
206	* describes Welford's method for accumulating this sum in one pass.
207	* If `count` is zero then this field must be zero.
208	*
209	* Generated from protobuf field <code>double sum_of_squared_deviation = 3;</code>
210	* @return float
211	*/
212	public function getSumOfSquaredDeviation()
213	{
214	return $this->sum_of_squared_deviation;
215	}
216
217	/**
218	* The sum of squared deviations from the mean of the values in the
219	* population. For values x_i this is:
220	* Sum[i=1..n]((x_i - mean)^2)
221	* Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition
222	* describes Welford's method for accumulating this sum in one pass.
223	* If `count` is zero then this field must be zero.
224	*
225	* Generated from protobuf field <code>double sum_of_squared_deviation = 3;</code>
226	* @param float $var
227	* @return $this
228	*/
229	public function setSumOfSquaredDeviation($var)
230	{
231	GPBUtil::checkDouble($var);
232	$this->sum_of_squared_deviation = $var;
233
234	return $this;
235	}
236
237	/**
238	* If specified, contains the range of the population values. The field
239	* must not be present if the `count` is zero.
240	*
241	* Generated from protobuf field <code>.google.api.Distribution.Range range = 4;</code>
242	* @return \Google\Api\Distribution\Range
243	*/
244	public function getRange()
245	{
246	return $this->range;
247	}
248
249	/**
250	* If specified, contains the range of the population values. The field
251	* must not be present if the `count` is zero.
252	*
253	* Generated from protobuf field <code>.google.api.Distribution.Range range = 4;</code>
254	* @param \Google\Api\Distribution\Range $var
255	* @return $this
256	*/
257	public function setRange($var)
258	{
259	GPBUtil::checkMessage($var, \Google\Api\Distribution_Range::class);
260	$this->range = $var;
261
262	return $this;
263	}
264
265	/**
266	* Defines the histogram bucket boundaries. If the distribution does not
267	* contain a histogram, then omit this field.
268	*
269	* Generated from protobuf field <code>.google.api.Distribution.BucketOptions bucket_options = 6;</code>
270	* @return \Google\Api\Distribution\BucketOptions
271	*/
272	public function getBucketOptions()
273	{
274	return $this->bucket_options;
275	}
276
277	/**
278	* Defines the histogram bucket boundaries. If the distribution does not
279	* contain a histogram, then omit this field.
280	*
281	* Generated from protobuf field <code>.google.api.Distribution.BucketOptions bucket_options = 6;</code>
282	* @param \Google\Api\Distribution\BucketOptions $var
283	* @return $this
284	*/
285	public function setBucketOptions($var)
286	{
287	GPBUtil::checkMessage($var, \Google\Api\Distribution_BucketOptions::class);
288	$this->bucket_options = $var;
289
290	return $this;
291	}
292
293	/**
294	* The number of values in each bucket of the histogram, as described in
295	* `bucket_options`. If the distribution does not have a histogram, then omit
296	* this field. If there is a histogram, then the sum of the values in
297	* `bucket_counts` must equal the value in the `count` field of the
298	* distribution.
299	* If present, `bucket_counts` should contain N values, where N is the number
300	* of buckets specified in `bucket_options`. If you supply fewer than N
301	* values, the remaining values are assumed to be 0.
302	* The order of the values in `bucket_counts` follows the bucket numbering
303	* schemes described for the three bucket types. The first value must be the
304	* count for the underflow bucket (number 0). The next N-2 values are the
305	* counts for the finite buckets (number 1 through N-2). The N'th value in
306	* `bucket_counts` is the count for the overflow bucket (number N-1).
307	*
308	* Generated from protobuf field <code>repeated int64 bucket_counts = 7;</code>
309	* @return \Google\Protobuf\Internal\RepeatedField
310	*/
311	public function getBucketCounts()
312	{
313	return $this->bucket_counts;
314	}
315
316	/**
317	* The number of values in each bucket of the histogram, as described in
318	* `bucket_options`. If the distribution does not have a histogram, then omit
319	* this field. If there is a histogram, then the sum of the values in
320	* `bucket_counts` must equal the value in the `count` field of the
321	* distribution.
322	* If present, `bucket_counts` should contain N values, where N is the number
323	* of buckets specified in `bucket_options`. If you supply fewer than N
324	* values, the remaining values are assumed to be 0.
325	* The order of the values in `bucket_counts` follows the bucket numbering
326	* schemes described for the three bucket types. The first value must be the
327	* count for the underflow bucket (number 0). The next N-2 values are the
328	* counts for the finite buckets (number 1 through N-2). The N'th value in
329	* `bucket_counts` is the count for the overflow bucket (number N-1).
330	*
331	* Generated from protobuf field <code>repeated int64 bucket_counts = 7;</code>
332	* @param int[]\|string[]\|\Google\Protobuf\Internal\RepeatedField $var
333	* @return $this
334	*/
335	public function setBucketCounts($var)
336	{
337	$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::INT64);
338	$this->bucket_counts = $arr;
339
340	return $this;
341	}
342
343	/**
344	* Must be in increasing order of `value` field.
345	*
346	* Generated from protobuf field <code>repeated .google.api.Distribution.Exemplar exemplars = 10;</code>
347	* @return \Google\Protobuf\Internal\RepeatedField
348	*/
349	public function getExemplars()
350	{
351	return $this->exemplars;
352	}
353
354	/**
355	* Must be in increasing order of `value` field.
356	*
357	* Generated from protobuf field <code>repeated .google.api.Distribution.Exemplar exemplars = 10;</code>
358	* @param \Google\Api\Distribution\Exemplar[]\|\Google\Protobuf\Internal\RepeatedField $var
359	* @return $this
360	*/
361	public function setExemplars($var)
362	{
363	$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Api\Distribution\Exemplar::class);
364	$this->exemplars = $arr;
365
366	return $this;
367	}
368
369	}
370
371