001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.apache.commons.rng.examples.jmh;
019
020import org.apache.commons.rng.UniformRandomProvider;
021import org.openjdk.jmh.annotations.Scope;
022import org.openjdk.jmh.annotations.Setup;
023import org.openjdk.jmh.annotations.State;
024
025/**
026 * A benchmark state that can retrieve the various generators defined by
027 * {@link org.apache.commons.rng.simple.RandomSource RandomSource} values.
028 *
029 * <p>The state will include only those that do not require additional constructor arguments.</p>
030 */
031@State(Scope.Benchmark)
032public class RandomSources extends RandomSourceValues {
033    /** RNG. */
034    private UniformRandomProvider generator;
035
036    /**
037     * Gets the generator.
038     *
039     * @return the RNG.
040     */
041    public UniformRandomProvider getGenerator() {
042        return generator;
043    }
044
045    /**
046     * Look-up the {@link org.apache.commons.rng.simple.RandomSource RandomSource} from the
047     * name and instantiates the generator.
048     */
049    @Override
050    @Setup
051    public void setup() {
052        super.setup();
053        generator = getRandomSource().create();
054    }
055}