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 package org.apache.commons.rng.sampling.distribution; 18 19 import org.apache.commons.rng.UniformRandomProvider; 20 21 /** 22 * Sampling from a <a href="https://en.wikipedia.org/wiki/Log-normal_distribution"> 23 * log-normal distribution</a>. 24 * Uses {@link BoxMullerNormalizedGaussianSampler} as the underlying sampler. 25 * 26 * <p>Sampling uses {@link UniformRandomProvider#nextDouble()}.</p> 27 * 28 * @since 1.0 29 * 30 * @deprecated Since version 1.1. Please use {@link LogNormalSampler} instead. 31 */ 32 @Deprecated 33 public class BoxMullerLogNormalSampler 34 extends SamplerBase 35 implements ContinuousSampler { 36 /** Delegate. */ 37 private final ContinuousSampler sampler; 38 39 /** 40 * @param rng Generator of uniformly distributed random numbers. 41 * @param mu Mean of the natural logarithm of the distribution values. 42 * @param sigma Standard deviation of the natural logarithm of the distribution values. 43 * @throws IllegalArgumentException if {@code sigma <= 0}. 44 */ 45 public BoxMullerLogNormalSampler(UniformRandomProvider rng, 46 double mu, 47 double sigma) { 48 super(null); 49 sampler = LogNormalSampler.of(new BoxMullerNormalizedGaussianSampler(rng), 50 mu, sigma); 51 } 52 53 /** {@inheritDoc} */ 54 @Override 55 public double sample() { 56 return sampler.sample(); 57 } 58 59 /** {@inheritDoc} */ 60 @Override 61 public String toString() { 62 return sampler.toString(); 63 } 64 }