Class AccuracyMode

Namespace

BenchmarkDotNet.Jobs

Assembly

BenchmarkDotNet.dll

public sealed class AccuracyMode : JobMode<AccuracyMode>

Inheritance

object

CharacteristicObject

CharacteristicObject<AccuracyMode>

JobMode<AccuracyMode>

AccuracyMode

Inherited Members

JobMode<AccuracyMode>.Default

JobMode<AccuracyMode>.Job

CharacteristicObject<AccuracyMode>.Apply(CharacteristicObject)

CharacteristicObject<AccuracyMode>.Apply(params CharacteristicObject[])

CharacteristicObject<AccuracyMode>.ApplyAndFreeze(CharacteristicObject)

CharacteristicObject<AccuracyMode>.ApplyAndFreeze(params CharacteristicObject[])

CharacteristicObject<AccuracyMode>.Freeze()

CharacteristicObject<AccuracyMode>.UnfreezeCopy()

CharacteristicObject.IdCharacteristic

CharacteristicObject.GetCharacteristicsWithValues()

CharacteristicObject.HasValue(Characteristic)

CharacteristicObject.ResolveValue<T>(Characteristic<T>, IResolver)

CharacteristicObject.ResolveValue<T>(Characteristic<T>, IResolver, T)

CharacteristicObject.ResolveValue(Characteristic, IResolver)

CharacteristicObject.ResolveValue(Characteristic, IResolver, object)

CharacteristicObject.ResolveValue<T>(Characteristic<T>, T)

CharacteristicObject.ResolveValue(Characteristic, object)

CharacteristicObject.ResolveValueAsNullable<T>(Characteristic<T>)

CharacteristicObject.ToString()

CharacteristicObject.Frozen

CharacteristicObject.HasChanges

CharacteristicObject.Id

Extension Methods

CharacteristicHelper.GetAllCharacteristics(CharacteristicObject)

CharacteristicHelper.GetThisTypeCharacteristics(CharacteristicObject)

Constructors

AccuracyMode()

public AccuracyMode()

Fields

AnalyzeLaunchVarianceCharacteristic

public static readonly Characteristic<bool> AnalyzeLaunchVarianceCharacteristic

Field Value

Characteristic<bool>

EvaluateOverheadCharacteristic

public static readonly Characteristic<bool> EvaluateOverheadCharacteristic

Field Value

Characteristic<bool>

MaxAbsoluteErrorCharacteristic

public static readonly Characteristic<TimeInterval> MaxAbsoluteErrorCharacteristic

Field Value

Characteristic<TimeInterval>

MaxRelativeErrorCharacteristic

public static readonly Characteristic<double> MaxRelativeErrorCharacteristic

Field Value

Characteristic<double>

MinInvokeCountCharacteristic

public static readonly Characteristic<int> MinInvokeCountCharacteristic

Field Value

Characteristic<int>

MinIterationTimeCharacteristic

public static readonly Characteristic<TimeInterval> MinIterationTimeCharacteristic

Field Value

Characteristic<TimeInterval>

OutlierModeCharacteristic

public static readonly Characteristic<OutlierMode> OutlierModeCharacteristic

Field Value

Characteristic<OutlierMode>

Properties

AnalyzeLaunchVariance

public bool AnalyzeLaunchVariance { get; set; }

Property Value

bool

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.

public bool EvaluateOverhead { get; set; }

Property Value

bool

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.

public TimeInterval MaxAbsoluteError { get; set; }

Property Value

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.

public double MaxRelativeError { get; set; }

Property Value

double

MinInvokeCount

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

public int MinInvokeCount { get; set; }

Property Value

int

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.

public TimeInterval MinIterationTime { get; set; }

Property Value

TimeInterval

OutlierMode

Specifies which outliers should be removed from the distribution.

public OutlierMode OutlierMode { get; set; }

Property Value

OutlierMode