Package jasima.core.random.discrete

Class IntBernoulli

java.lang.Object

jasima.core.random.continuous.DblSequence

jasima.core.random.discrete.IntSequence

jasima.core.random.discrete.IntBernoulli

All Implemented Interfaces:

Serializable, Cloneable

public class IntBernoulli
extends IntSequence

This class implements a discrete number stream following a Bernoulli distribution. This means, it contains the value 0 with a probability of 1-probabilityOfSuccess and the value 1 with a probability of probabilityOfSuccess.

Author:

Torsten Hildebrandt

See Also:

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

Field Summary

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

rndGen

Constructor Summary

Constructors

Constructor	Description
IntBernoulli()
IntBernoulli(double probabilityOfSuccess)

Method Summary

Modifier and Type	Method	Description
double	getNumericalMean()	Returns the arithmetic mean of the values returned by DblSequence.nextDbl().
double	getProbabilityOfSuccess()
Pair<Double,Double>	getValueRange()	This method computes the minimum and maximum support values (range of possible values) of this stream.
int	nextInt()
void	setProbabilityOfSuccess(double probOfSuccess)	Sets the probability of success.
String	toString()

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

IntBernoulli

public IntBernoulli()

IntBernoulli

public IntBernoulli(double probabilityOfSuccess)

Method Detail

nextInt

public int nextInt()

Specified by:

nextInt in class IntSequence

getNumericalMean

public double getNumericalMean()

Description copied from class: DblSequence

Returns the arithmetic mean of the values returned by DblSequence.nextDbl().

Overrides:

getNumericalMean in class DblSequence

getValueRange

public Pair<Double,Double> getValueRange()

Description copied from class: DblSequence

This method computes the minimum and maximum support values (range of possible values) of this stream.

Overrides:

getValueRange in class DblSequence

Returns:

A Pair containing the minimum and maximum support values.

toString

public String toString()

Overrides:

toString in class Object

getProbabilityOfSuccess

public double getProbabilityOfSuccess()

setProbabilityOfSuccess

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

Sets the probability of success.

Parameters:

probOfSuccess - The success probability.

Throws:

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