net.sf.doodleproject.numerics4j.random
Class CauchyRandomVariable

java.lang.Object
  extended by net.sf.doodleproject.numerics4j.random.AbstractContinuousRandomVariable
      extended by net.sf.doodleproject.numerics4j.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
Version:
$Revision: 1.4 $ $Date: 2007/11/18 23:51:19 $

Constructor Summary
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
 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 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

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.


Copyright 2004-2004-2007 DoodleProject. All Rights Reserved.