Package jasima.core.random.discrete

Class IntBinomial

java.lang.Object

jasima.core.random.continuous.DblSequence

jasima.core.random.discrete.IntSequence

jasima.core.random.discrete.IntDistribution

jasima.core.random.discrete.IntBinomial

All Implemented Interfaces:

Serializable, Cloneable

public class IntBinomial
extends IntDistribution

This class implements a discrete number stream following a Binomial distribution. It has two parameters, the probability of success (in a single trial) and the total number of trials conducted.

Author:

Torsten Hildebrandt

See Also:

Binomial distribution (Wikipedia), Binomial distribution (MathWorld), Serialized Form

Field Summary

Fields inherited from class jasima.core.random.continuous.DblSequence

rndGen

Constructor Summary

Constructors

Constructor	Description
IntBinomial()
IntBinomial(int n, double p)

Method Summary

Modifier and Type	Method	Description
int	getNumTrials()
double	getProbabilityOfSuccess()
protected void	setDistribution(org.apache.commons.math3.distribution.IntegerDistribution distribution)	Sets the discrete distribution to use.
void	setNumTrials(int numTrials)	Sets the number of trails of the Bernoulli experiment.
void	setProbabilityOfSuccess(double probOfSuccess)	Sets the probability of success in a single trial.
String	toString()

Methods inherited from class jasima.core.random.discrete.IntDistribution

getDistribution, getNumericalMean, getValueRange, nextInt

Methods inherited from class jasima.core.random.discrete.IntSequence

clone, nextDbl

Methods inherited from class jasima.core.random.continuous.DblSequence

createStreamDefFromStream, getName, getRndGen, init, max, min, setName, setRndGen

Methods inherited from class java.lang.Object

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

Constructor Detail

IntBinomial

public IntBinomial()

IntBinomial

public IntBinomial(int n,
                   double p)

Method Detail

setDistribution

protected void setDistribution(org.apache.commons.math3.distribution.IntegerDistribution distribution)

Description copied from class: IntDistribution

Sets the discrete distribution to use.

Overrides:

setDistribution in class IntDistribution

toString

public String toString()

Overrides:

toString in class IntDistribution

getProbabilityOfSuccess

public double getProbabilityOfSuccess()

setProbabilityOfSuccess

public void setProbabilityOfSuccess(double probOfSuccess)
                             throws org.apache.commons.math3.exception.OutOfRangeException

Sets the probability of success in a single trial.

Parameters:

probOfSuccess - The success probability.

Throws:

org.apache.commons.math3.exception.OutOfRangeException - If the supplied probability is not in the interval [0,1].

getNumTrials

public int getNumTrials()

setNumTrials

public void setNumTrials(int numTrials)
                  throws org.apache.commons.math3.exception.NotPositiveException

Sets the number of trails of the Bernoulli experiment.

Parameters:

numTrials - The number of trials.

Throws:

org.apache.commons.math3.exception.NotPositiveException - If the supplied value was negative.