media-cloud-sync / includes / sdk / google / google / common-protos / src / Api / Distribution.php

Distribution.php in Media Cloud Sync 1.1.1, at includes/sdk/google/google/common-protos/src/Api/Distribution.php

363 lines 15.2 KB

Raw Download Zip

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