jhplot.math.num.random

Class NegativeBinomialRandomVariable

java.lang.Object

jhplot.math.num.random.AbstractDiscreteRandomVariable

jhplot.math.num.random.NegativeBinomialRandomVariable

All Implemented Interfaces:

DiscreteRandomVariable

public class NegativeBinomialRandomVariable
extends AbstractDiscreteRandomVariable

A random variable generator for the Negative Binomial distribution.

References:

1. Wikipedia contributors, "Negative Binomial Distribution," Wikipedia, The Free Encyclopedia, http://en.wikipedia.org/wiki/Negative_binomial_distribution

Since:

1.3

Constructor Summary

Constructors

Constructor and Description
NegativeBinomialRandomVariable() Default constructor.
NegativeBinomialRandomVariable(int r, double p) Create a random variable with the given number of successes and probability of success.
NegativeBinomialRandomVariable(int r, double p, RNG source) Create a random variable with the given parameters.

Method Summary

Modifier and Type	Method and Description
int	nextRandomVariable() Access the next random variable from this generator.
static int	nextRandomVariable(int r, double p, 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

NegativeBinomialRandomVariable

public NegativeBinomialRandomVariable()

Default constructor. Number of successes is set to one and probability of success is set to 0.5.

NegativeBinomialRandomVariable

public NegativeBinomialRandomVariable(int r,
                                      double p)

Create a random variable with the given number of successes and probability of success.

Parameters:

r - the number of successes.

p - the probability of success.

NegativeBinomialRandomVariable

public NegativeBinomialRandomVariable(int r,
                                      double p,
                                      RNG source)

Create a random variable with the given parameters.

Parameters:

r - the number of successes.

p - the probability of success.

source - the source generator.

Method Detail

nextRandomVariable

public static int nextRandomVariable(int r,
                                     double p,
                                     RNG source)

Access the next random variable using the given generator.

Parameters:

r - the number of successes.

p - the probability of success.

source - the source generator.

Returns:

the next random variable.

nextRandomVariable

public int nextRandomVariable()

Access the next random variable from this generator.

Returns:

the next random variable.