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 * Create an instance. 035 * 036 * @param rng Generator of uniformly distributed random numbers. 037 */ 038 protected SamplerBase(UniformRandomProvider rng) { 039 this.rng = rng; 040 } 041 042 /** 043 * Return the next {@code double} value. 044 * 045 * @return a random value from a uniform distribution in the 046 * interval {@code [0, 1)}. 047 */ 048 protected double nextDouble() { 049 return rng.nextDouble(); 050 } 051 052 /** 053 * Return the next {@code int} value. 054 * 055 * @return a random {@code int} value. 056 */ 057 protected int nextInt() { 058 return rng.nextInt(); 059 } 060 061 /** 062 * Return the next {@code int} value. 063 * 064 * @param max Upper bound (excluded). 065 * @return a random {@code int} value in the interval {@code [0, max)}. 066 */ 067 protected int nextInt(int max) { 068 return rng.nextInt(max); 069 } 070 071 /** 072 * Return the next {@code long} value. 073 * 074 * @return a random {@code long} value. 075 */ 076 protected long nextLong() { 077 return rng.nextLong(); 078 } 079 080 /** {@inheritDoc} */ 081 @Override 082 public String toString() { 083 return "rng=" + rng.toString(); 084 } 085}