Class RunMode

Inheritance

Object

CharacteristicObject

CharacteristicObject<RunMode>

JobMode<RunMode>

RunMode

Inherited Members

JobMode<RunMode>.Default

JobMode<RunMode>.Job

CharacteristicObject<RunMode>.Apply(CharacteristicObject)

CharacteristicObject<RunMode>.Apply(CharacteristicObject[])

CharacteristicObject<RunMode>.ApplyAndFreeze(CharacteristicObject)

CharacteristicObject<RunMode>.ApplyAndFreeze(CharacteristicObject[])

CharacteristicObject<RunMode>.Freeze()

CharacteristicObject<RunMode>.UnfreezeCopy()

CharacteristicObject<RunMode>.CreateCharacteristic<TC>(String)

CharacteristicObject<RunMode>.CreateHiddenCharacteristic<TC>(String)

CharacteristicObject<RunMode>.CreateIgnoreOnApplyCharacteristic<TC>(String)

CharacteristicObject.ResolveId(CharacteristicObject, String)

CharacteristicObject.IdCharacteristic

CharacteristicObject.OwnerOrSelf

CharacteristicObject.Frozen

CharacteristicObject.IsPropertyBag

CharacteristicObject.HasChanges

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.ApplyCore(CharacteristicObject)

CharacteristicObject.FreezeCore()

CharacteristicObject.UnfreezeCopyCore()

CharacteristicObject.Id

CharacteristicObject.ToString()

Namespace: BenchmarkDotNet.Jobs

Assembly: BenchmarkDotNet.dll

Syntax

public sealed class RunMode : JobMode<RunMode>

Constructors

RunMode()

Declaration

public RunMode()

Fields

Dry

Declaration

public static readonly RunMode Dry

Field Value

Type	Description
RunMode

InvocationCountCharacteristic

Declaration

public static readonly Characteristic<int> InvocationCountCharacteristic

Field Value

Type	Description
Characteristic<Int32>

IterationCountCharacteristic

Declaration

public static readonly Characteristic<int> IterationCountCharacteristic

Field Value

Type	Description
Characteristic<Int32>

IterationTimeCharacteristic

Declaration

public static readonly Characteristic<TimeInterval> IterationTimeCharacteristic

Field Value

Type	Description
Characteristic<TimeInterval>

LaunchCountCharacteristic

Declaration

public static readonly Characteristic<int> LaunchCountCharacteristic

Field Value

Type	Description
Characteristic<Int32>

Long

Declaration

public static readonly RunMode Long

Field Value

Type	Description
RunMode

MaxIterationCountCharacteristic

Declaration

public static readonly Characteristic<int> MaxIterationCountCharacteristic

Field Value

Type	Description
Characteristic<Int32>

MaxWarmupIterationCountCharacteristic

Declaration

public static readonly Characteristic<int> MaxWarmupIterationCountCharacteristic

Field Value

Type	Description
Characteristic<Int32>

Medium

Declaration

public static readonly RunMode Medium

Field Value

Type	Description
RunMode

MemoryRandomizationCharacteristic

Declaration

public static readonly Characteristic<bool> MemoryRandomizationCharacteristic

Field Value

Type	Description
Characteristic<Boolean>

MinIterationCountCharacteristic

Declaration

public static readonly Characteristic<int> MinIterationCountCharacteristic

Field Value

Type	Description
Characteristic<Int32>

MinWarmupIterationCountCharacteristic

Declaration

public static readonly Characteristic<int> MinWarmupIterationCountCharacteristic

Field Value

Type	Description
Characteristic<Int32>

RunStrategyCharacteristic

Declaration

public static readonly Characteristic<RunStrategy> RunStrategyCharacteristic

Field Value

Type	Description
Characteristic<RunStrategy>

Short

Declaration

public static readonly RunMode Short

Field Value

Type	Description
RunMode

UnrollFactorCharacteristic

Declaration

public static readonly Characteristic<int> UnrollFactorCharacteristic

Field Value

Type	Description
Characteristic<Int32>

VeryLong

Declaration

public static readonly RunMode VeryLong

Field Value

Type	Description
RunMode

WarmupCountCharacteristic

Declaration

public static readonly Characteristic<int> WarmupCountCharacteristic

Field Value

Type	Description
Characteristic<Int32>

Properties

InvocationCount

Invocation count in a single iteration. If specified, IterationTime will be ignored. If specified, it must be a multiple of UnrollFactor.

Declaration

public int InvocationCount { get; set; }

Property Value

Type	Description
Int32

IterationCount

How many target iterations should be performed If specified, MinIterationCount will be ignored. If specified, MaxIterationCount will be ignored.

Declaration

public int IterationCount { get; set; }

Property Value

Type	Description
Int32

IterationTime

Desired time of execution of an iteration. Used by Pilot stage to estimate the number of invocations per iteration. The default value is 500 milliseconds.

Declaration

public TimeInterval IterationTime { get; set; }

Property Value

Type	Description
TimeInterval

LaunchCount

How many times we should launch process with target benchmark.

Declaration

public int LaunchCount { get; set; }

Property Value

Type	Description
Int32

MaxIterationCount

Maximum count of target iterations that should be performed The default value is 100 If you set this value to below 15, then MultimodalDistributionAnalyzer is not going to work

Declaration

public int MaxIterationCount { get; set; }

Property Value

Type	Description
Int32

MaxWarmupIterationCount

Maximum count of warmup iterations that should be performed The default value is 50

Declaration

public int MaxWarmupIterationCount { get; set; }

Property Value

Type	Description
Int32

MemoryRandomization

specifies whether Engine should allocate some random-sized memory between iterations it makes [GlobalCleanup] and [GlobalSetup] methods to be executed after every iteration

Declaration

public bool MemoryRandomization { get; set; }

Property Value

Type	Description
Boolean

MinIterationCount

Minimum count of target iterations that should be performed The default value is 15 If you set this value to below 15, then MultimodalDistributionAnalyzer is not going to work

Declaration

public int MinIterationCount { get; set; }

Property Value

Type	Description
Int32

MinWarmupIterationCount

Minimum count of warmup iterations that should be performed The default value is 6

Declaration

public int MinWarmupIterationCount { get; set; }

Property Value

Type	Description
Int32

RunStrategy

Available values: Throughput and ColdStart. Throughput: default strategy which allows to get good precision level. ColdStart: should be used only for measuring cold start of the application or testing purpose. Monitoring: no overhead evaluating, with several target iterations. Perfect for macrobenchmarks without a steady state with high variance.

Declaration

public RunStrategy RunStrategy { get; set; }

Property Value

Type	Description
RunStrategy

UnrollFactor

How many times the benchmark method will be invoked per one iteration of a generated loop.

Declaration

public int UnrollFactor { get; set; }

Property Value

Type	Description
Int32

WarmupCount

How many warmup iterations should be performed.

Declaration

public int WarmupCount { get; set; }

Property Value

Type	Description
Int32

Extension Methods

CharacteristicHelper.GetThisTypeCharacteristics(CharacteristicObject)

CharacteristicHelper.GetAllCharacteristics(CharacteristicObject)