Namespace BenchmarkDotNet.Attributes
Classes
- EvaluateOverheadAttribute
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.
- GcConcurrentAttribute
Specifies whether the common language runtime runs garbage collection on a separate thread.
false: Does not run garbage collection concurrently. true: Runs garbage collection concurrently. This is the default.
- GcForceAttribute
Specifies whether the BenchmarkDotNet's benchmark runner forces full garbage collection after each benchmark invocation
false: Does not force garbage collection. true: Forces full garbage collection after each benchmark invocation. This is the default.
- GcServerAttribute
Specifies whether the common language runtime runs server garbage collection.
false: Does not run server garbage collection. This is the default. true: Runs server garbage collection.
- GlobalCleanupAttribute
Marks method to be executed after all benchmark iterations.
It's going to be executed only once, after all benchmark runs.
- GlobalSetupAttribute
Marks method to be executed before all benchmark iterations.
It's going to be executed only once, just before warm up.
- InnerIterationCountAttribute
Invocation count in a single iteration. Does exactly the same as InvocationCountAttribute, added to make porting from xunit-performance to BenchmarkDotNet easier
- InvocationCountAttribute
Invocation count in a single iteration. If specified, IterationTime will be ignored. If specified, it must be a multiple of UnrollFactor.
- IterationCleanupAttribute
Marks method to be executed after each benchmark iteration. This should NOT be used for microbenchmarks - please see the docs.
- IterationCountAttribute
How many target iterations should be performed If specified, MinIterationCount will be ignored. If specified, MaxIterationCount will be ignored.
- IterationSetupAttribute
Marks method to be executed before each benchmark iteration. This should NOT be used for microbenchmarks - please see the docs.
- IterationTimeAttribute
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.
- KeepBenchmarkFilesAttribute
determines if all auto-generated files should be kept or removed after running the benchmarks
- MValueColumnAttribute
Prints mvalue. See http://www.brendangregg.com/FrequencyTrails/modes.html
- MaxAbsoluteErrorAttribute
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.
- MaxIterationCountAttribute
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
- MaxRelativeErrorAttribute
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.
- MaxWarmupCountAttribute
Maximum count of warmup iterations that should be performed The default value is 50
- MemoryRandomizationAttribute
specifies whether Engine should allocate some random-sized memory between iterations
it makes [GlobalCleanup] and [GlobalSetup] methods to be executed after every iteration
- MinInvokeCountAttribute
Minimum count of benchmark invocations per iteration. The default value is 4.
- MinIterationCountAttribute
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.
- MinIterationTimeAttribute
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.
- MinWarmupCountAttribute
Minimum count of warmup iterations that should be performed The default value is 6
- NamespaceColumnAttribute
Add a column with the target method namespace.
- OutliersAttribute
Specifies which outliers should be removed from the distribution
- ProcessCountAttribute
How many times we should launch process with target benchmark.
- RunOncePerIterationAttribute
Run the benchmark exactly once per iteration.
- StopOnFirstErrorAttribute
determines if running should be stop after first error
- TargetedAttribute
Base class for attributes that are targeted at one or more method(s)
- UnicodeConsoleLoggerAttribute
Enable unicode support in console logger
- WarmupCountAttribute
How many warmup iterations should be performed.