Class DefaultOrderer

Inheritance
Object
DefaultOrderer
Implements
Namespace: BenchmarkDotNet.Order
Assembly: BenchmarkDotNet.dll
Syntax
public class DefaultOrderer : IOrderer

Constructors

DefaultOrderer(SummaryOrderPolicy, MethodOrderPolicy)

Declaration
public DefaultOrderer(SummaryOrderPolicy summaryOrderPolicy = SummaryOrderPolicy.Default, MethodOrderPolicy methodOrderPolicy = MethodOrderPolicy.Declared)
Parameters
Type Name Description
SummaryOrderPolicy summaryOrderPolicy
MethodOrderPolicy methodOrderPolicy

Fields

Instance

Declaration
public static readonly IOrderer Instance
Field Value
Type Description
IOrderer

Properties

MethodOrderPolicy

Declaration
public MethodOrderPolicy MethodOrderPolicy { get; }
Property Value
Type Description
MethodOrderPolicy

SeparateLogicalGroups

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

SummaryOrderPolicy

Declaration
public SummaryOrderPolicy SummaryOrderPolicy { get; }
Property Value
Type Description
SummaryOrderPolicy

Methods

GetExecutionOrder(ImmutableArray<BenchmarkCase>, IEnumerable<BenchmarkLogicalGroupRule>)

Declaration
public virtual IEnumerable<BenchmarkCase> GetExecutionOrder(ImmutableArray<BenchmarkCase> benchmarkCases, IEnumerable<BenchmarkLogicalGroupRule> order = null)
Parameters
Type Name Description
ImmutableArray<BenchmarkCase> benchmarkCases
IEnumerable<BenchmarkLogicalGroupRule> order
Returns
Type Description
IEnumerable<BenchmarkCase>

GetHighlightGroupKey(BenchmarkCase)

Declaration
public string GetHighlightGroupKey(BenchmarkCase benchmarkCase)
Parameters
Type Name Description
BenchmarkCase benchmarkCase
Returns
Type Description
String

GetLogicalGroupKey(ImmutableArray<BenchmarkCase>, BenchmarkCase)

Declaration
public string GetLogicalGroupKey(ImmutableArray<BenchmarkCase> allBenchmarksCases, BenchmarkCase benchmarkCase)
Parameters
Type Name Description
ImmutableArray<BenchmarkCase> allBenchmarksCases
BenchmarkCase benchmarkCase
Returns
Type Description
String

GetLogicalGroupOrder(IEnumerable<IGrouping<String, BenchmarkCase>>, IEnumerable<BenchmarkLogicalGroupRule>)

Declaration
public virtual IEnumerable<IGrouping<string, BenchmarkCase>> GetLogicalGroupOrder(IEnumerable<IGrouping<string, BenchmarkCase>> logicalGroups, IEnumerable<BenchmarkLogicalGroupRule> order = null)
Parameters
Type Name Description
IEnumerable<IGrouping<String, BenchmarkCase>> logicalGroups
IEnumerable<BenchmarkLogicalGroupRule> order
Returns
Type Description
IEnumerable<IGrouping<String, BenchmarkCase>>

GetSummaryOrder(ImmutableArray<BenchmarkCase>, Summary)

Declaration
public virtual IEnumerable<BenchmarkCase> GetSummaryOrder(ImmutableArray<BenchmarkCase> benchmarksCases, Summary summary)
Parameters
Type Name Description
ImmutableArray<BenchmarkCase> benchmarksCases
Summary summary
Returns
Type Description
IEnumerable<BenchmarkCase>

GetSummaryOrderForGroup(ImmutableArray<BenchmarkCase>, Summary)

Declaration
protected virtual IEnumerable<BenchmarkCase> GetSummaryOrderForGroup(ImmutableArray<BenchmarkCase> benchmarksCase, Summary summary)
Parameters
Type Name Description
ImmutableArray<BenchmarkCase> benchmarksCase
Summary summary
Returns
Type Description
IEnumerable<BenchmarkCase>

Implements