Distribution class

Distribution represents a frequency distribution of double-valued sample points. It contains the size of the population of sample points plus additional optional information:

  • the arithmetic mean of the samples
  • the minimum and maximum of the samples
  • the sum-squared-deviation of the samples, used to compute variance
  • a histogram of the values of the sample points
Available extensions

Constructors

Distribution({Int64? count, double? mean, double? minimum, double? maximum, double? sumOfSquaredDeviation, Iterable<Int64>? bucketCounts, Distribution_LinearBuckets? linearBuckets, Distribution_ExponentialBuckets? exponentialBuckets, Distribution_ExplicitBuckets? explicitBuckets, Iterable<Distribution_Exemplar>? exemplars})
factory
Distribution.fromBuffer(List<int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory
Distribution.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory

Properties

bucketCounts → PbList<Int64>
The number of samples in each histogram bucket. bucket_counts are optional. If present, they must sum to the count value.
no setter
count ↔ Int64
The total number of samples in the distribution. Must be >= 0.
getter/setter pair
exemplars → PbList<Distribution_Exemplar>
Example points. Must be in increasing order of value field.
no setter
explicitBuckets ↔ Distribution_ExplicitBuckets
Buckets with arbitrary user-provided width.
getter/setter pair
exponentialBuckets ↔ Distribution_ExponentialBuckets
Buckets with exponentially growing width.
getter/setter pair
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
info_ → BuilderInfo
no setter
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
linearBuckets ↔ Distribution_LinearBuckets
Buckets with constant width.
getter/setter pair
maximum ↔ double
The maximum of the population of values. Ignored if count is zero.
getter/setter pair
mean ↔ double
The arithmetic mean of the samples in the distribution. If count is zero then this field must be zero.
getter/setter pair
minimum ↔ double
The minimum of the population of values. Ignored if count is zero.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sumOfSquaredDeviation ↔ double
The sum of squared deviations from the mean: Sumi=1..count((x_i - mean)^2) where each x_i is a sample values. If count is zero then this field must be zero, otherwise validation of the request fails.
getter/setter pair
unknownFields → UnknownFieldSet
no setterinherited

Methods

addExtension(Extension extension, Object? value) → void
Adds an extension field value to a repeated field.
inherited
check() → void
Throws a StateError if the message has required fields without a value.
inherited
clear() → void
Clears all data that was set in this message.
inherited
clearBucketOption() → void
clearCount() → void
clearExplicitBuckets() → void
clearExponentialBuckets() → void
clearExtension(Extension extension) → void
Clears an extension field and also removes the extension.
inherited
clearField(int tagNumber) → void
Clears the contents of a given field.
inherited
clearLinearBuckets() → void
clearMaximum() → void
clearMean() → void
clearMinimum() → void
clearSumOfSquaredDeviation() → void
clone() → Distribution
Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
copyWith(void updates(Distribution)) → Distribution
Apply updates to a copy of this message.
createEmptyInstance() → Distribution
Creates an empty instance of the same message type as this.
deepCopy() → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Returns a writable deep copy of this message.
ensureExplicitBuckets() → Distribution_ExplicitBuckets
ensureExponentialBuckets() → Distribution_ExponentialBuckets
ensureLinearBuckets() → Distribution_LinearBuckets
extensionsAreInitialized() → bool
inherited
freeze() → GeneratedMessage
Make this message read-only.
inherited
getDefaultForField(int tagNumber) → dynamic
Returns the default value for the given field.
inherited
getExtension(Extension extension) → dynamic
Returns the value of extension.
inherited
getField(int tagNumber) → dynamic
Returns the value of the field associated with tagNumber, or the default value if it is not set.
inherited
getFieldOrNull(int tagNumber) → dynamic
Returns the value of a field, ignoring any defaults.
inherited
getTagNumber(String fieldName) → int?
inherited
hasCount() → bool
hasExplicitBuckets() → bool
hasExponentialBuckets() → bool
hasExtension(Extension extension) → bool
Returns true if a value of extension is present.
inherited
hasField(int tagNumber) → bool
Whether this message has a field associated with tagNumber.
inherited
hasLinearBuckets() → bool
hasMaximum() → bool
hasMean() → bool
hasMinimum() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasSumOfSquaredDeviation() → bool
isInitialized() → bool
Whether all required fields in the message and embedded messages are set.
inherited
mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges serialized protocol buffer data into this message.
inherited
mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Same as mergeFromBuffer, but takes a CodedBufferReader input.
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.
inherited
mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from a JSON object represented as a Dart map.
inherited
mergeFromMessage(GeneratedMessage other) → void
Merges the contents of the other into this message.
inherited
mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void
Merges field values from json, a JSON object using proto3 encoding.
inherited
mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(void updates(T)) → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Apply updates to a copy of this message.
setExtension(Extension extension, Object value) → void
Sets the value of a non-repeated extension field to value.
inherited
setField(int tagNumber, Object value) → void
Sets the value of a field by its tagNumber.
inherited
toBuilder() → GeneratedMessage
Creates a writable, shallow copy of this message.
inherited
toDebugString() → String
Returns a String representation of this message.
inherited
toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?
Returns an Object representing Proto3 JSON serialization of this.
inherited
toString() → String
Returns a String representation of this message.
inherited
whichBucketOption() → Distribution_BucketOption
writeToBuffer() → Uint8List
Serialize the message as the protobuf binary format.
inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void
Same as writeToBuffer, but serializes to the given CodedBufferWriter.
inherited
writeToJson() → String
Returns a JSON string that encodes this message.
inherited
writeToJsonMap() → Map<String, dynamic>
Returns the JSON encoding of this message as a Dart Map.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

create() → Distribution
createRepeated() → PbList<Distribution>
getDefault() → Distribution