net.sf.doodleproject.numerics4j.random
Class RayleighRandomVariable

java.lang.Object
  net.sf.doodleproject.numerics4j.random.AbstractContinuousRandomVariable
      net.sf.doodleproject.numerics4j.random.RayleighRandomVariable

All Implemented Interfaces:

ContinuousRandomVariable

public class RayleighRandomVariable
extends AbstractContinuousRandomVariable

A random variable generator for the Rayleigh distribution.

References:

1. Wikipedia contributors, "Rayleigh Distribution," Wikipedia, The Free Encyclopedia, http://en.wikipedia.org/wiki/Rayleigh_distribution

Since:

1.3

Version:

$Revision: 1.4 $ $Date: 2007/11/18 23:51:19 $

Constructor Summary

RayleighRandomVariable()
Default constructor.

RayleighRandomVariable(double s)
Create a random variable with the given mean.

RayleighRandomVariable(double s, RNG source)
Create a random variable with the given parameters.

Method Summary

double	nextRandomVariable() Access the next random variable from this generator.
static double	nextRandomVariable(double s, RNG source) Access the next random variable using the given generator.

Methods inherited from class net.sf.doodleproject.numerics4j.random.AbstractContinuousRandomVariable

getSource, nextRandomNumber

Methods inherited from class java.lang.Object

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

Constructor Detail

RayleighRandomVariable

public RayleighRandomVariable()

Default constructor. Alpha and scale are both set to 1.

RayleighRandomVariable

public RayleighRandomVariable(double s)

Create a random variable with the given mean.

Parameters:

s - the scale parameter.

RayleighRandomVariable

public RayleighRandomVariable(double s,
                              RNG source)

Create a random variable with the given parameters.

Parameters:

s - the scale parameter.

source - the source generator.

Method Detail

nextRandomVariable

public static double nextRandomVariable(double s,
                                        RNG source)

Access the next random variable using the given generator.

Parameters:

s - the scale parameter.

source - the source generator.

Returns:

the next random variable.

nextRandomVariable

public double nextRandomVariable()

Access the next random variable from this generator.

Returns:

the next random variable.