com.carrotsearch.junitbenchmarks.BenchmarkOptions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of junit-benchmarks Show documentation

A framework for writing performance micro-benchmarks using JUnit4 annotations, forked from https://github.com/carrotsearch/junit-benchmarks.

There is a newer version: 0.7.4-scijava

Show newest version

package com.carrotsearch.junitbenchmarks;

import java.lang.annotation.*;

/**
 * Benchmark options applicable to methods annotated as tests.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(
{
    ElementType.TYPE, ElementType.METHOD
})
public @interface BenchmarkOptions
{
    /**
     * Sequential runs (no threads).
     */
    public final static int CONCURRENCY_SEQUENTIAL = -1;

    /**
     * Runs the benchmark with the number of threads reported
     * by {@link Runtime#availableProcessors()}.
     */
    public final static int CONCURRENCY_AVAILABLE_CORES = 0;

    /**
     * @return Call {@link System#gc()} before each test. This may slow down the tests in
     *         a significant way, so disabling it is sensible in most cases.
     */
    boolean callgc() default false;

    /**
     * Sets the number of warmup rounds for the test. If negative, the default is taken
     * from global options.
     */
    int warmupRounds() default -1;

    /**
     * Sets the number of benchmark rounds for the test. If negative, the default is taken
     * from global options.
     */
    int benchmarkRounds() default -1;

    /**
     * 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:
     * 

     * {@link #CONCURRENCY_SEQUENTIAL} - executed sequentially
     * {@link #CONCURRENCY_AVAILABLE_CORES} - executed concurrently with as many threads as reported by
     * {@link Runtime#availableProcessors()}.
     * any other integer > 0 - executed concurrently with the given number of threads
     * 
     */
    int concurrency() default CONCURRENCY_SEQUENTIAL;

    /**
     * Sets the type of clock to be used for time measuring.
     * See {@link Clock} for available values.
     *
     */
    Clock clock() default Clock.REAL_TIME;
}