Class: Google::Apis::DiscoveryengineV1::GoogleApiDistribution

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1/classes.rb,
lib/google/apis/discoveryengine_v1/representations.rb,
lib/google/apis/discoveryengine_v1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleApiDistribution

Returns a new instance of GoogleApiDistribution.



103
104
105
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 103

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#bucket_counts ⇒ Array<Fixnum>

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). Corresponds to the JSON property bucketCounts

Returns:

  • (Array<Fixnum>) 


53
54
55
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 53

def bucket_counts
  @bucket_counts
end

#bucket_options ⇒ Google::Apis::DiscoveryengineV1::GoogleApiDistributionBucketOptions

BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket. A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is - infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite. Corresponds to the JSON property bucketOptions

Returns:



70
71
72
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 70

def bucket_options
  @bucket_options
end

#count ⇒ Fixnum

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. Corresponds to the JSON property count

Returns:

  • (Fixnum) 


76
77
78
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 76

def count
  @count
end

#exemplars ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleApiDistributionExemplar>

Must be in increasing order of value field. Corresponds to the JSON property exemplars

Returns:



81
82
83
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 81

def exemplars
  @exemplars
end

#mean ⇒ Float

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

Returns:

  • (Float) 


87
88
89
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 87

def mean
  @mean
end

#range ⇒ Google::Apis::DiscoveryengineV1::GoogleApiDistributionRange

The range of the population values. Corresponds to the JSON property range

Returns:



92
93
94
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 92

def range
  @range
end

#sum_of_squared_deviation ⇒ Float

The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sumi=1..n 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. Corresponds to the JSON property sumOfSquaredDeviation

Returns:

  • (Float) 


101
102
103
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 101

def sum_of_squared_deviation
  @sum_of_squared_deviation
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



108
109
110
111
112
113
114
115
116
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 108

def update!(**args)
  @bucket_counts = args[:bucket_counts] if args.key?(:bucket_counts)
  @bucket_options = args[:bucket_options] if args.key?(:bucket_options)
  @count = args[:count] if args.key?(:count)
  @exemplars = args[:exemplars] if args.key?(:exemplars)
  @mean = args[:mean] if args.key?(:mean)
  @range = args[:range] if args.key?(:range)
  @sum_of_squared_deviation = args[:sum_of_squared_deviation] if args.key?(:sum_of_squared_deviation)
end