Interface IOrderer

Namespace: BenchmarkDotNet.Order

Assembly: BenchmarkDotNet.dll

Syntax

public interface IOrderer

Properties

SeparateLogicalGroups

Declaration

bool SeparateLogicalGroups { get; }

Property Value

Type	Description
Boolean

Methods

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

Declaration

IEnumerable<BenchmarkCase> GetExecutionOrder(ImmutableArray<BenchmarkCase> benchmarksCase, IEnumerable<BenchmarkLogicalGroupRule> order = null)

Parameters

Type	Name	Description
ImmutableArray<BenchmarkCase>	benchmarksCase
IEnumerable<BenchmarkLogicalGroupRule>	order

Returns

Type	Description
IEnumerable<BenchmarkCase>

GetHighlightGroupKey(BenchmarkCase)

Declaration

string GetHighlightGroupKey(BenchmarkCase benchmarkCase)

Parameters

Type	Name	Description
BenchmarkCase	benchmarkCase

Returns

Type	Description
String

GetLogicalGroupKey(ImmutableArray<BenchmarkCase>, BenchmarkCase)

Declaration

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

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

IEnumerable<BenchmarkCase> GetSummaryOrder(ImmutableArray<BenchmarkCase> benchmarksCases, Summary summary)

Parameters

Type	Name	Description
ImmutableArray<BenchmarkCase>	benchmarksCases
Summary	summary

Returns

Type	Description
IEnumerable<BenchmarkCase>