bcds.tools.random
Class RndLogNormal

java.lang.Object
  bcds.tools.random.RndGenBase
      bcds.tools.random.RndLogNormal

All Implemented Interfaces:

RndGen

public class RndLogNormal
extends RndGenBase
implements RndGen

Generates random values following a lognormal distribution with given mean and standard deviation. NOTE: This code is taken from Torch v3 (version 3.1, 2004) by Ronan Collobert and others: http://www.torch.ch/

It is a BSD-licensed code, as follows:

 ----------------------------------------------------------
 Copyright (c) 2003 Ronan Collobert (IDIAP, Trebolloc & Co)
 Copyright (c) 2003 Samy Bengio (IDIAP)
 Copyright (c) 2003 Johnny Marithoz (IDIAP)
 
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without 
 modification, are permitted provided that the following conditions are met:
 
     * Redistributions of source code must retain the above copyright 
       notice, this list of conditions and the following disclaimer.
     * Redistributions in binary form must reproduce the above copyright notice, 
       this list of conditions and the following disclaimer in the 
       documentation and/or other materials provided with the distribution.
     * The name of the author may not be used to endorse or promote products 
       derived from this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 
 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN 
 NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 
 TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 
 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 
 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
 ----------------------------------------------------------
 

Constructor Summary

RndLogNormal(double mean, double sigma)
Creates a new instance with specific desired mean and standard deviation (sigma).

RndLogNormal(java.util.Random rnd, double mean, double sigma)
Creates a new instance with specific desired mean and standard deviation (sigma), with the randomness source set to rnd.

Method Summary

double

next() Returns a random value drawn from a lognormal distribution.

Methods inherited from class bcds.tools.random.RndGenBase

getRandomGen, setRandomGen

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface bcds.tools.random.RndGen

getRandomGen, setRandomGen

Constructor Detail

RndLogNormal

public RndLogNormal(double mean,
                    double sigma)

Creates a new instance with specific desired mean and standard deviation (sigma). The randomness source is the default.

RndLogNormal

public RndLogNormal(java.util.Random rnd,
                    double mean,
                    double sigma)

Creates a new instance with specific desired mean and standard deviation (sigma), with the randomness source set to rnd.

Method Detail

next

public double next()

Returns a random value drawn from a lognormal distribution.

Specified by:

next in interface RndGen