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 * @since 1.0 27 * 28 * @deprecated Since version 1.1. Please use {@link LogNormalSampler} instead. 29 */ 30 @Deprecated 31 public class BoxMullerLogNormalSampler 32 extends SamplerBase 33 implements ContinuousSampler { 34 /** Delegate. */ 35 private final ContinuousSampler sampler; 36 37 /** 38 * @param rng Generator of uniformly distributed random numbers. 39 * @param scale Scale of the log-normal distribution. 40 * @param shape Shape of the log-normal distribution. 41 */ 42 public BoxMullerLogNormalSampler(UniformRandomProvider rng, 43 double scale, 44 double shape) { 45 super(null); 46 sampler = new LogNormalSampler(new BoxMullerNormalizedGaussianSampler(rng), 47 scale, shape); 48 } 49 50 /** {@inheritDoc} */ 51 @Override 52 public double sample() { 53 return sampler.sample(); 54 } 55 56 /** {@inheritDoc} */ 57 @Override 58 public String toString() { 59 return sampler.toString(); 60 } 61 }