Class AccuracyMode

Inheritance
Object
CharacteristicObject
CharacteristicObject<AccuracyMode>
JobMode<AccuracyMode>
AccuracyMode
Inherited Members
Namespace: BenchmarkDotNet.Jobs
Assembly: BenchmarkDotNet.dll
Syntax
public sealed class AccuracyMode : JobMode<AccuracyMode>

Fields

AnalyzeLaunchVarianceCharacteristic

Declaration
public static readonly Characteristic<bool> AnalyzeLaunchVarianceCharacteristic
Field Value
Type Description
Characteristic<Boolean>

EvaluateOverheadCharacteristic

Declaration
public static readonly Characteristic<bool> EvaluateOverheadCharacteristic
Field Value
Type Description
Characteristic<Boolean>

MaxAbsoluteErrorCharacteristic

Declaration
public static readonly Characteristic<TimeInterval> MaxAbsoluteErrorCharacteristic
Field Value
Type Description
Characteristic<TimeInterval>

MaxRelativeErrorCharacteristic

Declaration
public static readonly Characteristic<double> MaxRelativeErrorCharacteristic
Field Value
Type Description
Characteristic<Double>

MinInvokeCountCharacteristic

Declaration
public static readonly Characteristic<int> MinInvokeCountCharacteristic
Field Value
Type Description
Characteristic<Int32>

MinIterationTimeCharacteristic

Declaration
public static readonly Characteristic<TimeInterval> MinIterationTimeCharacteristic
Field Value
Type Description
Characteristic<TimeInterval>

OutlierModeCharacteristic

Declaration
public static readonly Characteristic<OutlierMode> OutlierModeCharacteristic
Field Value
Type Description
Characteristic<OutlierMode>

Properties

AnalyzeLaunchVariance

Declaration
public bool AnalyzeLaunchVariance { get; set; }
Property Value
Type Description
Boolean

EvaluateOverhead

Specifies if the overhead should be evaluated (Idle runs) and it's average value subtracted from every result. True by default, very important for nano-benchmarks.

Declaration
public bool EvaluateOverhead { get; set; }
Property Value
Type Description
Boolean

MaxAbsoluteError

Maximum acceptable error for a benchmark (by default, BenchmarkDotNet continue iterations until the actual error is less than the specified error). Doesn't have a default value. If MaxRelativeError is also provided, the smallest value is used as stop criteria.

Declaration
public TimeInterval MaxAbsoluteError { get; set; }
Property Value
Type Description
TimeInterval

MaxRelativeError

Maximum acceptable error for a benchmark (by default, BenchmarkDotNet continue iterations until the actual error is less than the specified error). The default value is 0.02. If MaxAbsoluteError is also provided, the smallest value is used as stop criteria.

Declaration
public double MaxRelativeError { get; set; }
Property Value
Type Description
Double

MinInvokeCount

Minimum count of benchmark invocations per iteration. The default value is 4.

Declaration
public int MinInvokeCount { get; set; }
Property Value
Type Description
Int32

MinIterationTime

Minimum time of a single iteration. Unlike Run.IterationTime, this characteristic specifies only the lower limit. In case of need, BenchmarkDotNet can increase this value. The default value is 500 milliseconds.

Declaration
public TimeInterval MinIterationTime { get; set; }
Property Value
Type Description
TimeInterval

OutlierMode

Specifies which outliers should be removed from the distribution.

Declaration
public OutlierMode OutlierMode { get; set; }
Property Value
Type Description
OutlierMode

Extension Methods