benchmark_metric_computation_enum_only.dart

/// The names for the values computed for each [BenchmarkMetric].
enum BenchmarkMetricComputation {
  /// The name for the computed value tracking the average value of the measured
  /// samples without outliers.
  average,

  /// The name for the computed value tracking the average of outlier samples.
  outlierAverage,

  /// The name for the computed value tracking the outlier average divided by
  /// the clean average.
  outlierRatio,

  /// The name for the computed value tracking the noise as a multiple of the
  /// [average] value takes from clean samples.
  noise,

  /// The name for the computed value tracking the 50th percentile value from
  /// the samples with outliers.
  p50(0.5),

  /// The name for the computed value tracking the 90th percentile value from
  /// the samples with outliers.
  p90(0.9),

  /// The name for the computed value tracking the 95th percentile value from
  /// the samples with outliers.
  p95(0.95);

  const BenchmarkMetricComputation([this.percentile]);

  final double? percentile;

  static final List<BenchmarkMetricComputation> percentileValues = values
    .where((BenchmarkMetricComputation value) => value.percentile != null)
    .toList();
}