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 */
017package org.apache.commons.rng.sampling.distribution;
018
019import org.apache.commons.rng.UniformRandomProvider;
020
021/**
022 * Base class for a sampler.
023 */
024public class SamplerBase {
025    /** RNG. */
026    private final UniformRandomProvider rng;
027
028    /**
029     * @param rng Generator of uniformly distributed random numbers.
030     */
031    protected SamplerBase(UniformRandomProvider rng) {
032        this.rng = rng;
033    }
034
035    /**
036     * @return a random value from a uniform distribution in the
037     * interval {@code [0, 1)}.
038     */
039    protected double nextDouble() {
040        return rng.nextDouble();
041    }
042
043    /**
044     * @return a random {@code int} value.
045     */
046    protected int nextInt() {
047        return rng.nextInt();
048    }
049
050    /**
051     * @param max Upper bound (excluded).
052     * @return a random {@code int} value in the interval {@code [0, max)}.
053     */
054    protected int nextInt(int max) {
055        return rng.nextInt(max);
056    }
057
058    /** {@inheritDoc} */
059    @Override
060    public String toString() {
061        return "rng=" + rng.toString();
062    }
063}