Class Summary

Namespace

BenchmarkDotNet.Reports

Assembly

BenchmarkDotNet.dll

public class Summary

Inheritance

object

Summary

Extension Methods

ReportExtensions.GetReportFor<T>(Summary, Expression<Action<T>>)

ReportExtensions.GetRunsFor<T>(Summary, Expression<Action<T>>)

SummaryExtensions.GetColumns(Summary)

SummaryExtensions.GetCultureInfo(Summary?)

SummaryExtensions.GetLogicalGroupForBenchmark(Summary, BenchmarkCase)

Constructors

Summary(string, ImmutableArray<BenchmarkReport>, HostEnvironmentInfo, string, string, TimeSpan, CultureInfo, ImmutableArray<ValidationError>, ImmutableArray<IColumnHidingRule>, SummaryStyle?)

public Summary(string title, ImmutableArray<BenchmarkReport> reports, HostEnvironmentInfo hostEnvironmentInfo, string resultsDirectoryPath, string logFilePath, TimeSpan totalTime, CultureInfo cultureInfo, ImmutableArray<ValidationError> validationErrors, ImmutableArray<IColumnHidingRule> columnHidingRules, SummaryStyle? summaryStyle = null)

Parameters

title string

reports ImmutableArray<BenchmarkReport>

hostEnvironmentInfo HostEnvironmentInfo

resultsDirectoryPath string

logFilePath string

totalTime TimeSpan

cultureInfo CultureInfo

validationErrors ImmutableArray<ValidationError>

columnHidingRules ImmutableArray<IColumnHidingRule>

summaryStyle SummaryStyle

Properties

AllRuntimes

public string AllRuntimes { get; }

Property Value

string

BenchmarksCases

public ImmutableArray<BenchmarkCase> BenchmarksCases { get; }

Property Value

ImmutableArray<BenchmarkCase>

ColumnHidingRules

public ImmutableArray<IColumnHidingRule> ColumnHidingRules { get; }

Property Value

ImmutableArray<IColumnHidingRule>

HasCriticalValidationErrors

public bool HasCriticalValidationErrors { get; }

Property Value

bool

HostEnvironmentInfo

public HostEnvironmentInfo HostEnvironmentInfo { get; }

Property Value

HostEnvironmentInfo

IsMultipleRuntimes

public bool IsMultipleRuntimes { get; }

Property Value

bool

this[BenchmarkCase]

Returns a report for the given benchmark or null if there is no a corresponded report.

public BenchmarkReport? this[BenchmarkCase benchmarkCase] { get; }

Parameters

benchmarkCase BenchmarkCase

Property Value

BenchmarkReport

LogFilePath

public string LogFilePath { get; }

Property Value

string

Orderer

public IOrderer Orderer { get; }

Property Value

IOrderer

Reports

public ImmutableArray<BenchmarkReport> Reports { get; }

Property Value

ImmutableArray<BenchmarkReport>

ResultsDirectoryPath

public string ResultsDirectoryPath { get; }

Property Value

string

Style

public SummaryStyle Style { get; }

Property Value

SummaryStyle

Table

public SummaryTable Table { get; }

Property Value

SummaryTable

Title

public string Title { get; }

Property Value

string

TotalTime

public TimeSpan TotalTime { get; }

Property Value

TimeSpan

ValidationErrors

public ImmutableArray<ValidationError> ValidationErrors { get; }

Property Value

ImmutableArray<ValidationError>

Methods

GetBaseline(string?)

public BenchmarkCase? GetBaseline(string? logicalGroupKey)

Parameters

logicalGroupKey string

Returns

BenchmarkCase

GetLogicalGroupKey(BenchmarkCase)

public string? GetLogicalGroupKey(BenchmarkCase benchmarkCase)

Parameters

benchmarkCase BenchmarkCase

Returns

string

GetNonBaselines(string)

public IEnumerable<BenchmarkCase> GetNonBaselines(string logicalGroupKey)

Parameters

logicalGroupKey string

Returns

IEnumerable<BenchmarkCase>

GetNumberOfExecutedBenchmarks()

public int GetNumberOfExecutedBenchmarks()

Returns

int

HasBaselines()

public bool HasBaselines()

Returns

bool

HasReport(BenchmarkCase)

public bool HasReport(BenchmarkCase benchmarkCase)

Parameters

benchmarkCase BenchmarkCase

Returns

bool

IsBaseline(BenchmarkCase)

public bool IsBaseline(BenchmarkCase benchmarkCase)

Parameters

benchmarkCase BenchmarkCase

Returns

bool