Interface IStoppingCriteria
A stopping criteria checks when it's time to terminate iteration in the current stage.
Namespace: BenchmarkDotNet.Engines
Assembly: BenchmarkDotNet.dll
Syntax
public interface IStoppingCriteriaProperties
MaxIterationCount
The maximum possible count of iterations. Engine needs this value for setting the maximum capacity of the returned list of measurements. The correct capacity helps to avoid infrastructure allocations during benchmarking.
Declaration
int MaxIterationCount { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
Title
Title which can be used in logs and diagnostics methods
Declaration
string Title { get; }Property Value
| Type | Description |
|---|---|
| String |
Warnings
An array of user-friendly warnings which notify about incorrect parameters.
Declaration
IReadOnlyList<string> Warnings { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyList<String> |
Methods
Evaluate(IReadOnlyList<Measurement>)
Checks do we have enough iterations
Declaration
StoppingResult Evaluate(IReadOnlyList<Measurement> measurements)Parameters
| Type | Name | Description |
|---|---|---|
| IReadOnlyList<Measurement> | measurements |
Returns
| Type | Description |
|---|---|
| StoppingResult |