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;
19
20 import org.apache.commons.rng.UniformRandomProvider;
21 import org.openjdk.jmh.annotations.Scope;
22 import org.openjdk.jmh.annotations.Setup;
23 import org.openjdk.jmh.annotations.State;
24
25 /**
26 * A benchmark state that can retrieve the various generators defined by
27 * {@link org.apache.commons.rng.simple.RandomSource RandomSource} values.
28 *
29 * <p>The state will include only those that do not require additional constructor arguments.</p>
30 */
31 @State(Scope.Benchmark)
32 public class RandomSources extends RandomSourceValues {
33 /** RNG. */
34 private UniformRandomProvider generator;
35
36 /**
37 * Gets the generator.
38 *
39 * @return the RNG.
40 */
41 public UniformRandomProvider getGenerator() {
42 return generator;
43 }
44
45 /**
46 * Look-up the {@link org.apache.commons.rng.simple.RandomSource RandomSource} from the
47 * name and instantiates the generator.
48 */
49 @Override
50 @Setup
51 public void setup() {
52 super.setup();
53 generator = getRandomSource().create();
54 }
55 }