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 *
024 * @since 1.0
025 *
026 * @deprecated Since version 1.1. Class intended for internal use only.
027 */
028@Deprecated
029public class SamplerBase {
030    /** RNG. */
031    private final UniformRandomProvider rng;
032
033    /**
034     * @param rng Generator of uniformly distributed random numbers.
035     */
036    protected SamplerBase(UniformRandomProvider rng) {
037        this.rng = rng;
038    }
039
040    /**
041     * @return a random value from a uniform distribution in the
042     * interval {@code [0, 1)}.
043     */
044    protected double nextDouble() {
045        return rng.nextDouble();
046    }
047
048    /**
049     * @return a random {@code int} value.
050     */
051    protected int nextInt() {
052        return rng.nextInt();
053    }
054
055    /**
056     * @param max Upper bound (excluded).
057     * @return a random {@code int} value in the interval {@code [0, max)}.
058     */
059    protected int nextInt(int max) {
060        return rng.nextInt(max);
061    }
062
063    /**
064     * @return a random {@code long} value.
065     */
066    protected long nextLong() {
067        return rng.nextLong();
068    }
069
070    /** {@inheritDoc} */
071    @Override
072    public String toString() {
073        return "rng=" + rng.toString();
074    }
075}