Package jasima.core.random.continuous

Class DblNormal

java.lang.Object

jasima.core.random.continuous.DblSequence

jasima.core.random.continuous.DblNormal

All Implemented Interfaces:

Serializable, Cloneable

public class DblNormal
extends DblSequence

Creates a number stream with values following a Normal distribution.

Author:

Torsten Hildebrandt

See Also:

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

Field Summary

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

rndGen

Constructor Summary

Constructors

Constructor	Description
DblNormal()
DblNormal(double mean, double stdev)

Method Summary

Modifier and Type	Method	Description
double	getMean()
double	getNumericalMean()	Returns the arithmetic mean of the values returned by DblSequence.nextDbl().
double	getStdev()
Pair<Double,Double>	getValueRange()	This method computes the minimum and maximum support values (range of possible values) of this stream.
double	nextDbl()	Returns the next number in this number stream.
void	setMean(double mean)	Sets the mean value of this normally distributed number stream.
void	setStdev(double stdev)	Sets the standard deviation of this normally distributed number stream.
String	toString()

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

clone, 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

DblNormal

public DblNormal()

DblNormal

public DblNormal(double mean,
                 double stdev)

Method Detail

nextDbl

public double nextDbl()

Description copied from class: DblSequence

Returns the next number in this number stream.

Specified by:

nextDbl in class DblSequence

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

getMean

public double getMean()

setMean

public void setMean(double mean)

Sets the mean value of this normally distributed number stream. Default value is 0.0.

Parameters:

mean - The mean value.

getStdev

public double getStdev()

setStdev

public void setStdev(double stdev)
              throws org.apache.commons.math3.exception.NotPositiveException

Sets the standard deviation of this normally distributed number stream. This defaults to 1.0.

Parameters:

stdev - The standard deviation.

Throws:

org.apache.commons.math3.exception.NotPositiveException - Raised if stdev was negative.