1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.commons.rng.examples.jmh.core;
19
20 import org.openjdk.jmh.annotations.BenchmarkMode;
21 import org.openjdk.jmh.annotations.Fork;
22 import org.openjdk.jmh.annotations.Measurement;
23 import org.openjdk.jmh.annotations.Mode;
24 import org.openjdk.jmh.annotations.OutputTimeUnit;
25 import org.openjdk.jmh.annotations.Scope;
26 import org.openjdk.jmh.annotations.State;
27 import org.openjdk.jmh.annotations.Warmup;
28
29 import java.util.concurrent.TimeUnit;
30
31 /**
32 * Declares the JMH annotations for the benchmarks to compare the speed of generation of
33 * random numbers from the various source providers for
34 * {@link org.apache.commons.rng.UniformRandomProvider UniformRandomProvider}.
35 *
36 * <p>Note: Implementing this as an {@code @interface} annotation results in errors as the
37 * meta-annotation is not expanded by the JMH annotation processor. The processor does however
38 * allow all annotations to be inherited from abstract classes.</p>
39 */
40 @BenchmarkMode(Mode.AverageTime)
41 @OutputTimeUnit(TimeUnit.NANOSECONDS)
42 @Warmup(iterations = 10, time = 1, timeUnit = TimeUnit.SECONDS)
43 @Measurement(iterations = 10, time = 1, timeUnit = TimeUnit.SECONDS)
44 @Fork(value = 1, jvmArgs = { "-server", "-Xms128M", "-Xmx128M" })
45 @State(Scope.Benchmark)
46 public abstract class AbstractBenchmark {
47 /**
48 * Create a new instance.
49 */
50 protected AbstractBenchmark() {
51 // Hide public constructor to prevent instantiation
52 }
53
54 // Empty. Serves as an annotation placeholder.
55 }