Class RunMode

Namespace

BenchmarkDotNet.Jobs

Assembly

BenchmarkDotNet.dll

public sealed class RunMode : JobMode<RunMode>

Inheritance

object

CharacteristicObject

CharacteristicObject<RunMode>

JobMode<RunMode>

RunMode

Inherited Members

JobMode<RunMode>.Default

JobMode<RunMode>.Job

CharacteristicObject<RunMode>.Apply(CharacteristicObject)

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

CharacteristicObject<RunMode>.ApplyAndFreeze(CharacteristicObject)

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

CharacteristicObject<RunMode>.Freeze()

CharacteristicObject<RunMode>.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

RunMode()

public RunMode()

Fields

Dry

public static readonly RunMode Dry

Field Value

RunMode

InvocationCountCharacteristic

public static readonly Characteristic<long> InvocationCountCharacteristic

Field Value

Characteristic<long>

IterationCountCharacteristic

public static readonly Characteristic<int> IterationCountCharacteristic

Field Value

Characteristic<int>

IterationTimeCharacteristic

public static readonly Characteristic<TimeInterval> IterationTimeCharacteristic

Field Value

Characteristic<TimeInterval>

LaunchCountCharacteristic

public static readonly Characteristic<int> LaunchCountCharacteristic

Field Value

Characteristic<int>

Long

public static readonly RunMode Long

Field Value

RunMode

MaxIterationCountCharacteristic

public static readonly Characteristic<int> MaxIterationCountCharacteristic

Field Value

Characteristic<int>

MaxWarmupIterationCountCharacteristic

public static readonly Characteristic<int> MaxWarmupIterationCountCharacteristic

Field Value

Characteristic<int>

Medium

public static readonly RunMode Medium

Field Value

RunMode

MemoryRandomizationCharacteristic

public static readonly Characteristic<bool> MemoryRandomizationCharacteristic

Field Value

Characteristic<bool>

MinIterationCountCharacteristic

public static readonly Characteristic<int> MinIterationCountCharacteristic

Field Value

Characteristic<int>

MinWarmupIterationCountCharacteristic

public static readonly Characteristic<int> MinWarmupIterationCountCharacteristic

Field Value

Characteristic<int>

RunStrategyCharacteristic

public static readonly Characteristic<RunStrategy> RunStrategyCharacteristic

Field Value

Characteristic<RunStrategy>

Short

public static readonly RunMode Short

Field Value

RunMode

UnrollFactorCharacteristic

public static readonly Characteristic<int> UnrollFactorCharacteristic

Field Value

Characteristic<int>

VeryLong

public static readonly RunMode VeryLong

Field Value

RunMode

WarmupCountCharacteristic

public static readonly Characteristic<int> WarmupCountCharacteristic

Field Value

Characteristic<int>

Properties

InvocationCount

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

public long InvocationCount { get; set; }

Property Value

long

IterationCount

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

public int IterationCount { get; set; }

Property Value

int

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.

public TimeInterval IterationTime { get; set; }

Property Value

TimeInterval

LaunchCount

How many times we should launch process with target benchmark.

public int LaunchCount { get; set; }

Property Value

int

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

public int MaxIterationCount { get; set; }

Property Value

int

MaxWarmupIterationCount

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

public int MaxWarmupIterationCount { get; set; }

Property Value

int

MemoryRandomization

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

public bool MemoryRandomization { get; set; }

Property Value

bool

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

public int MinIterationCount { get; set; }

Property Value

int

MinWarmupIterationCount

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

public int MinWarmupIterationCount { get; set; }

Property Value

int

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.

public RunStrategy RunStrategy { get; set; }

Property Value

RunStrategy

UnrollFactor

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

public int UnrollFactor { get; set; }

Property Value

int

WarmupCount

How many warmup iterations should be performed.

public int WarmupCount { get; set; }

Property Value

int