Table of Contents

Class StatisticalTestColumn

Namespace
BenchmarkDotNet.Columns
Assembly
BenchmarkDotNet.dll
public class StatisticalTestColumn : BaselineCustomColumn, IColumn
Inheritance
StatisticalTestColumn
Implements
Inherited Members
Extension Methods

Constructors

StatisticalTestColumn(StatisticalTestKind, Threshold, bool) 

public StatisticalTestColumn(StatisticalTestKind kind, Threshold threshold, bool showPValues = false)

Parameters

kind StatisticalTestKind
threshold Threshold
showPValues bool

Properties

ColumnName

Display column title in the summary.

public override string ColumnName { get; }

Property Value

string

Id

An unique identifier of the column. If there are several columns with the same Id, only one of them will be shown in the summary.

public override string Id { get; }

Property Value

string

IsNumeric

Defines if the column's value represents a number

public override bool IsNumeric { get; }

Property Value

bool

Kind 

public StatisticalTestKind Kind { get; }

Property Value

StatisticalTestKind

Legend

Column description.

public override string Legend { get; }

Property Value

string

PriorityInCategory

Defines order of column in the same category.

public override int PriorityInCategory { get; }

Property Value

int

ShowPValues 

public bool ShowPValues { get; }

Property Value

bool

Threshold 

public Threshold Threshold { get; }

Property Value

Threshold

UnitType

Defines how to format column's value

public override UnitType UnitType { get; }

Property Value

UnitType

Methods

Create(StatisticalTestKind, Threshold, bool) 

public static StatisticalTestColumn Create(StatisticalTestKind kind, Threshold threshold, bool showPValues = false)

Parameters

kind StatisticalTestKind
threshold Threshold
showPValues bool

Returns

StatisticalTestColumn

GetValue(Summary, BenchmarkCase, Statistics, IReadOnlyDictionary<string, Metric>, Statistics, IReadOnlyDictionary<string, Metric>, bool) 

public override string GetValue(Summary summary, BenchmarkCase benchmarkCase, Statistics baseline, IReadOnlyDictionary<string, Metric> baselineMetrics, Statistics current, IReadOnlyDictionary<string, Metric> currentMetrics, bool isBaseline)

Parameters

summary Summary
benchmarkCase BenchmarkCase
baseline Statistics
baselineMetrics IReadOnlyDictionary<string, Metric>
current Statistics
currentMetrics IReadOnlyDictionary<string, Metric>
isBaseline bool

Returns

string