Class BaselineCustomColumn

Namespace

BenchmarkDotNet.Columns

Assembly

BenchmarkDotNet.dll

public abstract class BaselineCustomColumn : IColumn

Inheritance

object

BaselineCustomColumn

Implements

IColumn

Derived

BaselineAllocationRatioColumn

BaselineRatioColumn

BaselineScaledColumn

StatisticalTestColumn

Extension Methods

ColumnExtensions.ToProvider(IColumn)

Constructors

BaselineCustomColumn()

protected BaselineCustomColumn()

Properties

AlwaysShow

public bool AlwaysShow { get; }

Property Value

bool

Category

public virtual ColumnCategory Category { get; }

Property Value

ColumnCategory

ColumnName

Display column title in the summary.

public abstract 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 abstract string Id { get; }

Property Value

string

IsNumeric

Defines if the column's value represents a number

public abstract bool IsNumeric { get; }

Property Value

bool

Legend

Column description.

public abstract string Legend { get; }

Property Value

string

PriorityInCategory

Defines order of column in the same category.

public abstract int PriorityInCategory { get; }

Property Value

int

UnitType

Defines how to format column's value

public abstract UnitType UnitType { get; }

Property Value

UnitType

Methods

GetValue(Summary, BenchmarkCase)

Value in this column formatted using the default style.

public string GetValue(Summary summary, BenchmarkCase benchmarkCase)

Parameters

summary Summary

benchmarkCase BenchmarkCase

Returns

string

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

public abstract 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

GetValue(Summary, BenchmarkCase, SummaryStyle)

Value in this column formatted using the specified style.

public string GetValue(Summary summary, BenchmarkCase benchmarkCase, SummaryStyle style)

Parameters

summary Summary

benchmarkCase BenchmarkCase

style SummaryStyle

Returns

string

IsAvailable(Summary)

public bool IsAvailable(Summary summary)

Parameters

summary Summary

Returns

bool

IsDefault(Summary, BenchmarkCase)

public bool IsDefault(Summary summary, BenchmarkCase benchmarkCase)

Parameters

summary Summary

benchmarkCase BenchmarkCase

Returns

bool

ToString()

public override string ToString()

Returns

string