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