com.carrotsearch.junitbenchmarks

Annotation Type BenchmarkOptions

@Retention(value=RUNTIME)
 @Target(value={TYPE,METHOD})
public @interface BenchmarkOptions

Benchmark options applicable to methods annotated as tests.

Field Summary

Fields

Modifier and Type	Fields and Description
static int	CONCURRENCY_AVAILABLE_CORES Runs the benchmark with the number of threads reported by Runtime.availableProcessors().
static int	CONCURRENCY_SEQUENTIAL Sequential runs (no threads).

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	benchmarkRounds Sets the number of benchmark rounds for the test.
boolean	callgc
Clock	clock Sets the type of clock to be used for time measuring.
int	concurrency Specifies the number of threads that should execute the benchmarked method in parallel.
int	warmupRounds Sets the number of warmup rounds for the test.

Field Detail

CONCURRENCY_SEQUENTIAL

public static final int CONCURRENCY_SEQUENTIAL

Sequential runs (no threads).

CONCURRENCY_AVAILABLE_CORES

public static final int CONCURRENCY_AVAILABLE_CORES

Runs the benchmark with the number of threads reported by Runtime.availableProcessors().

Element Detail

callgc

public abstract boolean callgc

Returns:

Call System.gc() before each test. This may slow down the tests in a significant way, so disabling it is sensible in most cases.

Default:

false

warmupRounds

public abstract int warmupRounds

Sets the number of warmup rounds for the test. If negative, the default is taken from global options.

Default:

-1

benchmarkRounds

public abstract int benchmarkRounds

Sets the number of benchmark rounds for the test. If negative, the default is taken from global options.

Default:

-1

concurrency

public abstract int concurrency

Specifies the number of threads that should execute the benchmarked method in parallel. This is a tricky thing to do and you should know what you're doing (because concurrent execution will affect GC and other measurements).

Allowed values:

• CONCURRENCY_SEQUENTIAL - executed sequentially
• CONCURRENCY_AVAILABLE_CORES - executed concurrently with as many threads as reported by Runtime.availableProcessors().
• any other integer > 0 - executed concurrently with the given number of threads

Default:

-1

clock

public abstract Clock clock

Sets the type of clock to be used for time measuring. See Clock for available values.

Default:

com.carrotsearch.junitbenchmarks.Clock.REAL_TIME