jhplot.math.num.random

Class CauchyRandomVariable

java.lang.Object

jhplot.math.num.random.AbstractContinuousRandomVariable

jhplot.math.num.random.CauchyRandomVariable

All Implemented Interfaces:

ContinuousRandomVariable

public class CauchyRandomVariable
extends AbstractContinuousRandomVariable

A random variable generator for the Cauchy distribution.

References:

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

Since:

1.3

Constructor Summary

Constructors

Constructor and Description
CauchyRandomVariable() Default constructor.
CauchyRandomVariable(double m, double s) Create a random variable with the given location and scale parameters.
CauchyRandomVariable(double m, double s, RNG source) Create a random variable with the given parameters.

Method Summary

Modifier and Type	Method and Description
double	nextRandomVariable() Access the next random variable from this generator.
static double	nextRandomVariable(double m, double s, RNG source) Access the next random variable using the given generator.

Methods inherited from class java.lang.Object

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

Constructor Detail

CauchyRandomVariable

public CauchyRandomVariable()

Default constructor. The location parameter is set to zero and the scale parameter is set to one.

CauchyRandomVariable

public CauchyRandomVariable(double m,
                            double s)

Create a random variable with the given location and scale parameters.

Parameters:

m - the location parameter.

s - the scale parameter.

CauchyRandomVariable

public CauchyRandomVariable(double m,
                            double s,
                            RNG source)

Create a random variable with the given parameters.

Parameters:

m - the location parameter.

s - the scale parameter.

source - the source generator.

Method Detail

nextRandomVariable

public static double nextRandomVariable(double m,
                                        double s,
                                        RNG source)

Access the next random variable using the given generator.

Parameters:

m - the location parameter.

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.