IRPact_modellierung.distributions

Class NegativeBinomialDistribution

java.lang.Object

IRPact_modellierung.distributions.Distribution

IRPact_modellierung.distributions.UnivariateDistribution

IRPact_modellierung.distributions.DiscreteDistribution

IRPact_modellierung.distributions.COLTDiscreteDistribution

IRPact_modellierung.distributions.NegativeBinomialDistribution

public class NegativeBinomialDistribution
extends COLTDiscreteDistribution

Class to represent a negative binomial distribution based on the COLT library.

Field Summary

Fields inherited from class IRPact_modellierung.distributions.COLTDiscreteDistribution

generator

Fields inherited from class IRPact_modellierung.distributions.Distribution

name

Constructor Summary

Constructors

Constructor and Description
NegativeBinomialDistribution(java.lang.String name, int n, double p) Creates a negative binomial distribution wrapping the corresponding COLT distribution.

Method Summary

Modifier and Type	Method and Description
double	draw() Draw a value from the distribution according to the distribution at hand
int	getN()
double	getP()
void	setN(int n)
void	setP(double p)

Methods inherited from class IRPact_modellierung.distributions.Distribution

getName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

NegativeBinomialDistribution

public NegativeBinomialDistribution(java.lang.String name,
                                    int n,
                                    double p)
                             throws java.lang.IllegalArgumentException

Creates a negative binomial distribution wrapping the corresponding COLT distribution. Will throw an error with invalid parameters (n < 1 or p not in unit interval)

Parameters:

name - Name of the distribution (will be prefixed with NegativeBinomialDistribution_)

n - number trials modeled

p - success probability of each trial

Throws:

java.lang.IllegalArgumentException - will be thrown when one of the parameter is out of range (n < 1 or p not in unit interval)

Method Detail

draw

public double draw()

Description copied from class: UnivariateDistribution

Draw a value from the distribution according to the distribution at hand

Specified by:

draw in class UnivariateDistribution

Returns:

A double number drawn from the modeled distribution

setN

public void setN(int n)

setP

public void setP(double p)

getN

public int getN()

getP

public double getP()