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(Threshold, SignificanceLevel?) 

public StatisticalTestColumn(Threshold threshold, SignificanceLevel? significanceLevel = null)

Parameters

threshold Threshold
significanceLevel SignificanceLevel?

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

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

SignificanceLevel 

public SignificanceLevel SignificanceLevel { get; }

Property Value

SignificanceLevel

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(Threshold, SignificanceLevel?) 

public static StatisticalTestColumn Create(Threshold threshold, SignificanceLevel? significanceLevel = null)

Parameters

threshold Threshold
significanceLevel SignificanceLevel?

Returns

StatisticalTestColumn

Create(string, SignificanceLevel?) 

public static StatisticalTestColumn Create(string threshold, SignificanceLevel? significanceLevel = null)

Parameters

threshold string
significanceLevel SignificanceLevel?

Returns

StatisticalTestColumn

CreateDefault() 

public static StatisticalTestColumn CreateDefault()

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