Class StatisticalTestColumn

Inheritance

Object

BaselineCustomColumn

StatisticalTestColumn

Implements

IColumn

Inherited Members

BaselineCustomColumn.GetValue(Summary, BenchmarkCase)

BaselineCustomColumn.IsAvailable(Summary)

BaselineCustomColumn.AlwaysShow

BaselineCustomColumn.Category

BaselineCustomColumn.GetValue(Summary, BenchmarkCase, SummaryStyle)

BaselineCustomColumn.ToString()

BaselineCustomColumn.IsDefault(Summary, BenchmarkCase)

Namespace: BenchmarkDotNet.Columns

Assembly: BenchmarkDotNet.dll

Syntax

public class StatisticalTestColumn : BaselineCustomColumn, IColumn

Constructors

StatisticalTestColumn(StatisticalTestKind, Threshold, Boolean)

Declaration

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

Parameters

Type	Name	Description
StatisticalTestKind	kind
Threshold	threshold
Boolean	showPValues

Properties

ColumnName

Declaration

public override string ColumnName { get; }

Property Value

Type	Description
String

Overrides

BaselineCustomColumn.ColumnName

Id

Declaration

public override string Id { get; }

Property Value

Type	Description
String

Overrides

BaselineCustomColumn.Id

IsNumeric

Declaration

public override bool IsNumeric { get; }

Property Value

Type	Description
Boolean

Overrides

BaselineCustomColumn.IsNumeric

Kind

Declaration

public StatisticalTestKind Kind { get; }

Property Value

Type	Description
StatisticalTestKind

Legend

Declaration

public override string Legend { get; }

Property Value

Type	Description
String

Overrides

BaselineCustomColumn.Legend

PriorityInCategory

Declaration

public override int PriorityInCategory { get; }

Property Value

Type	Description
Int32

Overrides

BaselineCustomColumn.PriorityInCategory

ShowPValues

Declaration

public bool ShowPValues { get; }

Property Value

Type	Description
Boolean

Threshold

Declaration

public Threshold Threshold { get; }

Property Value

Type	Description
Threshold

UnitType

Declaration

public override UnitType UnitType { get; }

Property Value

Type	Description
UnitType

Overrides

BaselineCustomColumn.UnitType

Methods

Create(StatisticalTestKind, Threshold, Boolean)

Declaration

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

Parameters

Type	Name	Description
StatisticalTestKind	kind
Threshold	threshold
Boolean	showPValues

Returns

Type	Description
StatisticalTestColumn

GetValue(Summary, BenchmarkCase, Statistics, IReadOnlyDictionary<String, Metric>, Statistics, IReadOnlyDictionary<String, Metric>, Boolean)

Declaration

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

Parameters

Type	Name	Description
Summary	summary
BenchmarkCase	benchmarkCase
Statistics	baseline
IReadOnlyDictionary<String, Metric>	baselineMetrics
Statistics	current
IReadOnlyDictionary<String, Metric>	currentMetrics
Boolean	isBaseline

Returns

Type	Description
String

Overrides

BaselineCustomColumn.GetValue(Summary, BenchmarkCase, Statistics, IReadOnlyDictionary<String, Metric>, Statistics, IReadOnlyDictionary<String, Metric>, Boolean)

Implements

IColumn

Extension Methods

ColumnExtensions.ToProvider(IColumn)