Class BenchmarkResults
The cumulative results for an entire Benchmark
Inheritance
System.Object
BenchmarkResults
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: NBench.Reporting
Assembly: NBench.dll
Syntax
public class BenchmarkResultsConstructors
BenchmarkResults(String, BenchmarkSettings, IReadOnlyList<BenchmarkRunReport>)
Declaration
public BenchmarkResults(string typeName, BenchmarkSettings settings, IReadOnlyList<BenchmarkRunReport> runs)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | typeName | |
| BenchmarkSettings | settings | |
| System.Collections.Generic.IReadOnlyList<BenchmarkRunReport> | runs |
Properties
BenchmarkName
Usually prints out the type name of the spec being run
Declaration
public string BenchmarkName { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Exceptions
The set of System.Exceptions that may have occurred during a benchmark.
Declaration
public IReadOnlyList<Exception> Exceptions { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IReadOnlyList<System.Exception> |
IsFaulted
Returns true if any System.Exceptions were thrown during this run.
Declaration
public bool IsFaulted { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Runs
The list of raw data available for each run of the benchmark
Declaration
public IReadOnlyList<BenchmarkRunReport> Runs { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IReadOnlyList<BenchmarkRunReport> |
Settings
The settings for this Benchmark
Declaration
public BenchmarkSettings Settings { get; }Property Value
| Type | Description |
|---|---|
| BenchmarkSettings |
StatsByMetric
Per-metric aggregate statistics
Declaration
public IReadOnlyDictionary<MetricName, AggregateMetrics> StatsByMetric { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IReadOnlyDictionary<MetricName, AggregateMetrics> |
Methods
Aggregate(IReadOnlyList<BenchmarkRunReport>)
Declaration
public static IReadOnlyDictionary<MetricName, AggregateMetrics> Aggregate(IReadOnlyList<BenchmarkRunReport> runs)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IReadOnlyList<BenchmarkRunReport> | runs |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IReadOnlyDictionary<MetricName, AggregateMetrics> |