Class DefaultOrderer

Namespace

BenchmarkDotNet.Order

Assembly

BenchmarkDotNet.dll

public class DefaultOrderer : IOrderer

Inheritance

object

DefaultOrderer

Implements

IOrderer

Constructors

DefaultOrderer(SummaryOrderPolicy, MethodOrderPolicy)

public DefaultOrderer(SummaryOrderPolicy summaryOrderPolicy = SummaryOrderPolicy.Default, MethodOrderPolicy methodOrderPolicy = MethodOrderPolicy.Declared)

Parameters

summaryOrderPolicy SummaryOrderPolicy

methodOrderPolicy MethodOrderPolicy

Fields

Instance

public static readonly IOrderer Instance

Field Value

IOrderer

Properties

MethodOrderPolicy

public MethodOrderPolicy MethodOrderPolicy { get; }

Property Value

MethodOrderPolicy

SeparateLogicalGroups

public bool SeparateLogicalGroups { get; }

Property Value

bool

SummaryOrderPolicy

public SummaryOrderPolicy SummaryOrderPolicy { get; }

Property Value

SummaryOrderPolicy

Methods

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

public virtual IEnumerable<BenchmarkCase> GetExecutionOrder(ImmutableArray<BenchmarkCase> benchmarkCases, IEnumerable<BenchmarkLogicalGroupRule>? order = null)

Parameters

benchmarkCases ImmutableArray<BenchmarkCase>

order IEnumerable<BenchmarkLogicalGroupRule>

Returns

IEnumerable<BenchmarkCase>

GetHighlightGroupKey(BenchmarkCase)

public string GetHighlightGroupKey(BenchmarkCase benchmarkCase)

Parameters

benchmarkCase BenchmarkCase

Returns

string

GetLogicalGroupKey(ImmutableArray<BenchmarkCase>, BenchmarkCase)

public string GetLogicalGroupKey(ImmutableArray<BenchmarkCase> allBenchmarksCases, BenchmarkCase benchmarkCase)

Parameters

allBenchmarksCases ImmutableArray<BenchmarkCase>

benchmarkCase BenchmarkCase

Returns

string

GetLogicalGroupOrder(IEnumerable<IGrouping<string, BenchmarkCase>>, IEnumerable<BenchmarkLogicalGroupRule>?)

public virtual IEnumerable<IGrouping<string, BenchmarkCase>> GetLogicalGroupOrder(IEnumerable<IGrouping<string, BenchmarkCase>> logicalGroups, IEnumerable<BenchmarkLogicalGroupRule>? order = null)

Parameters

logicalGroups IEnumerable<IGrouping<string, BenchmarkCase>>

order IEnumerable<BenchmarkLogicalGroupRule>

Returns

IEnumerable<IGrouping<string, BenchmarkCase>>

GetSummaryOrder(ImmutableArray<BenchmarkCase>, Summary)

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

Parameters

benchmarksCases ImmutableArray<BenchmarkCase>

summary Summary

Returns

IEnumerable<BenchmarkCase>

GetSummaryOrderForGroup(ImmutableArray<BenchmarkCase>, Summary)

protected virtual IEnumerable<BenchmarkCase> GetSummaryOrderForGroup(ImmutableArray<BenchmarkCase> benchmarksCase, Summary summary)

Parameters

benchmarksCase ImmutableArray<BenchmarkCase>

summary Summary

Returns

IEnumerable<BenchmarkCase>