Table of Contents

Class BaselineScaledColumn

Namespace
BenchmarkDotNet.Columns
Assembly
BenchmarkDotNet.dll
[Obsolete("Use BaselineRatioColumn")]
public class BaselineScaledColumn : BaselineCustomColumn, IColumn
Inheritance
BaselineScaledColumn
Implements
Inherited Members
Extension Methods

Fields

Scaled 

public static readonly IColumn Scaled

Field Value

IColumn

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 BaselineScaledColumn.ScaledKind Kind { get; }

Property Value

BaselineScaledColumn.ScaledKind

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

UnitType

Defines how to format column's value

public override UnitType UnitType { get; }

Property Value

UnitType

Methods

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