|
ImageScience 3.0.0 | ||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectimagescience.random.PoissonGenerator
public class PoissonGenerator
Poisson random number generator. This implementation is based on the algorithm described by W. H. Press, S. A. Teukolsky, W. T. Vetterling, B. P. Flannery, Numerical Recipes in C: The Art of Scientific Computing (2nd edition), Cambridge University Press, Cambridge, 1992, Section 7.3, and uses UniformGenerator
as a source of uniform random numbers.
Constructor Summary | |
---|---|
PoissonGenerator()
Constructs a generator of random numbers from the Poisson distribution with unit mean and initialized with a random seed. |
|
PoissonGenerator(double mean)
Constructs a generator of random numbers from the Poisson distribution with given mean and initialized with a random seed. |
|
PoissonGenerator(double mean,
int seed)
Constructs a generator of random numbers from the Poisson distribution with given mean and initialized with the given seed . |
|
PoissonGenerator(int seed)
Constructs a generator of random numbers from the Poisson distribution with unit mean and initialized with the given seed . |
Method Summary | |
---|---|
double |
next()
Returns a random number from the Poisson distribution with mean specified at construction. |
double |
next(double mean)
Returns a random number from the Poisson distribution with given mean . |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PoissonGenerator()
public PoissonGenerator(int seed)
seed
.
seed
- The seed used for initialization of the generator.public PoissonGenerator(double mean)
mean
and initialized with a random seed.
mean
- The mean of the distribution. Must be larger than or equal to 0
.
java.lang.IllegalArgumentException
- If mean
is less than 0
.public PoissonGenerator(double mean, int seed)
mean
and initialized with the given seed
.
mean
- The mean of the distribution. Must be larger than or equal to 0
.seed
- The seed used for initialization of the generator.
java.lang.IllegalArgumentException
- If mean
is less than 0
.Method Detail |
---|
public double next()
next
in interface RandomGenerator
public double next(double mean)
mean
.
mean
- The mean of the distribution. Must be larger than or equal to 0
.
java.lang.IllegalArgumentException
- If mean
is less than 0
.
|
ImageScience 3.0.0 | ||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright (C) Erik Meijering. Permission to use this software and corresponding documentation for educational, research, and not-for-profit purposes, without a fee and without a signed licensing agreement, is granted, subject to the following terms and conditions.
IT IS NOT ALLOWED TO REDISTRIBUTE, SELL, OR LEASE THIS SOFTWARE, OR DERIVATIVE WORKS THEREOF, WITHOUT PERMISSION IN WRITING FROM THE COPYRIGHT HOLDER. THE COPYRIGHT HOLDER IS FREE TO MAKE VERSIONS OF THE SOFTWARE AVAILABLE FOR A FEE OR COMMERCIALLY ONLY.
IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, OF ANY KIND WHATSOEVER, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE EXPRESS OR IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE AND CORRESPONDING DOCUMENTATION IS PROVIDED "AS IS". THE COPYRIGHT HOLDER HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.