Class BaselineCustomColumn

Inheritance
Object
BaselineCustomColumn
BaselineAllocationRatioColumn
BaselineRatioColumn
BaselineScaledColumn
StatisticalTestColumn
Implements
Namespace: BenchmarkDotNet.Columns
Assembly: BenchmarkDotNet.dll
Syntax
public abstract class BaselineCustomColumn : IColumn

Properties

AlwaysShow

Declaration
public bool AlwaysShow { get; }
Property Value
Type Description
Boolean

Category

Declaration
public virtual ColumnCategory Category { get; }
Property Value
Type Description
ColumnCategory

ColumnName

Declaration
public abstract string ColumnName { get; }
Property Value
Type Description
String

Id

Declaration
public abstract string Id { get; }
Property Value
Type Description
String

IsNumeric

Declaration
public abstract bool IsNumeric { get; }
Property Value
Type Description
Boolean

Legend

Declaration
public abstract string Legend { get; }
Property Value
Type Description
String

PriorityInCategory

Declaration
public abstract int PriorityInCategory { get; }
Property Value
Type Description
Int32

UnitType

Declaration
public abstract UnitType UnitType { get; }
Property Value
Type Description
UnitType

Methods

GetValue(Summary, BenchmarkCase)

Declaration
public string GetValue(Summary summary, BenchmarkCase benchmarkCase)
Parameters
Type Name Description
Summary summary
BenchmarkCase benchmarkCase
Returns
Type Description
String

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

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

GetValue(Summary, BenchmarkCase, SummaryStyle)

Declaration
public string GetValue(Summary summary, BenchmarkCase benchmarkCase, SummaryStyle style)
Parameters
Type Name Description
Summary summary
BenchmarkCase benchmarkCase
SummaryStyle style
Returns
Type Description
String

IsAvailable(Summary)

Declaration
public bool IsAvailable(Summary summary)
Parameters
Type Name Description
Summary summary
Returns
Type Description
Boolean

IsDefault(Summary, BenchmarkCase)

Declaration
public bool IsDefault(Summary summary, BenchmarkCase benchmarkCase)
Parameters
Type Name Description
Summary summary
BenchmarkCase benchmarkCase
Returns
Type Description
Boolean

ToString()

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

Implements

Extension Methods