uk.ac.soton.simulation.jsit.core

Class DistNegativeBinomial

java.lang.Object

uk.ac.soton.simulation.jsit.core.AbstractStochasticItem

uk.ac.soton.simulation.jsit.core.Distribution

uk.ac.soton.simulation.jsit.core.DistributionDiscrete

uk.ac.soton.simulation.jsit.core.DistNegativeBinomial

All Implemented Interfaces:

java.io.Serializable, ContinuousSampler

public class DistNegativeBinomial
extends DistributionDiscrete
implements java.io.Serializable

JSIT representation of a negative binomial distribution. This uses the formulation as in most statistical definitions (e.g., Wolfram Math World, atRisk) where it gives the number of failures before n successes in a sequence of independent trials, each with probability of success p.

Compare this to Wikipedia's definition, where it is the number of successes before r failures.

Since:

0.2

Author:

Stuart Rossiter

See Also:

Serialized Form

Field Summary

Fields inherited from class uk.ac.soton.simulation.jsit.core.DistributionDiscrete

CUMULATIVE_PROB_TOLERANCE

Constructor Summary

Constructors

Constructor and Description
DistNegativeBinomial(int n, double p) Create a negative binomial distribution instance.

Method Summary

Modifier and Type	Method and Description
Distribution	createUnregisteredCopy() Create an unregistered copy of this distribution.
int	getN() Get the distribution's n parameter (number of successes).
double	getP() Get the distribution's p parameter (probability of success).
void	setN(int n) Change (set) the n parameter of the distribution.
void	setP(double p) Change (set) the p parameter of the distribution.
java.lang.String	toString() Custom toString implementation.

Methods inherited from class uk.ac.soton.simulation.jsit.core.DistributionDiscrete

sampleDouble, sampleInt

Methods inherited from class uk.ac.soton.simulation.jsit.core.Distribution

createRegisteredCopy

Methods inherited from class uk.ac.soton.simulation.jsit.core.AbstractStochasticItem

getSampler, registerAccessInfo, registerSampler

Methods inherited from class java.lang.Object

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

Constructor Detail

DistNegativeBinomial

public DistNegativeBinomial(int n,
                            double p)

Create a negative binomial distribution instance.

Parameters:

n - The n parameter (number of successes).

p - The p parameter (probability of success per trial).

Since:

0.2

Method Detail

setP

public void setP(double p)

Change (set) the p parameter of the distribution.

Parameters:

p - The new p parameter (probability of success).

getP

public double getP()

Get the distribution's p parameter (probability of success).

Returns:

The p value.

setN

public void setN(int n)

Change (set) the n parameter of the distribution.

Parameters:

n - The new n parameter (number of successes).

getN

public int getN()

Get the distribution's n parameter (number of successes).

Returns:

The n parameter.

toString

public java.lang.String toString()

Custom toString implementation.

Specified by:

toString in class DistributionDiscrete

Returns:

A string representation of the distribution; e.g., "NegBin(8, 0.5)".

Since:

0.2

createUnregisteredCopy

public Distribution createUnregisteredCopy()

Create an unregistered copy of this distribution.

Specified by:

createUnregisteredCopy in class Distribution

Returns:

The unregistered copy. (This will need casting as appropriate.)

Since:

0.2