A representation of a random variable. More...

Inherited by Simulator.ConstantRandomVariable, Simulator.EmpiricalRandomVariable, Simulator.ErlangRandomVariable, Simulator.ExponentialRandomVariable, Simulator.NormalRandomVariable, Simulator.PoissonRandomVariable, Simulator.TriangularRandomVariable, Simulator.UniformRandomVariable, and Simulator.WeibullRandomVariable.

Public Member Functions
void	init (double[] parameters)
	Initialize this variable with the given parameters. Intended to be used only by RandomVariableFactory.
double	next ()
	Draw a random value from this random variable.
void	multiply (double m)
	Modify this variable so as to multiply every draw from this random variable by the argument m.
double	getMean ()
	Return the mean of this variable.
double	getStddev ()
	Return the standard deviation of this variable. For empirical variables, standard deviation is calculated using the population variance (not a sample variance).
double	getPercentile (double n)
	Provide the value that represents the nth percentile from the data contained in this variable. Most useful for empirical data.
string	describeVariable (ITimeFormatter itf=null)
	Return a human-readable description of this variable.
string	getStringDescription ()
	Return a string representation of this random variable. This description could be fed back into RandomVariableFactory.create() to produce a duplicate of this variable.
Properties
string	name `[get]`
	The name of this type of random variable.
string[]	parameterNames `[get]`
	The names of the parameters describing this variable.

Detailed Description

A representation of a random variable.

Member Function Documentation

string Simulator.IRandomVariable.describeVariable ( ITimeFormatter itf = null )

Return a human-readable description of this variable.

Parameters:

itf	If this parameter is specified, the numbers in the description will be formatted according to the given formatter.

Returns:

Implemented in Simulator.ConstantRandomVariable, Simulator.EmpiricalRandomVariable, Simulator.ErlangRandomVariable, Simulator.ExponentialRandomVariable, Simulator.NormalRandomVariable, Simulator.PoissonRandomVariable, Simulator.TriangularRandomVariable, Simulator.UniformRandomVariable, and Simulator.WeibullRandomVariable.

double Simulator.IRandomVariable.getMean ( )

Return the mean of this variable.

Returns:

Implemented in Simulator.ConstantRandomVariable, Simulator.EmpiricalRandomVariable, Simulator.ErlangRandomVariable, Simulator.ExponentialRandomVariable, Simulator.NormalRandomVariable, Simulator.PoissonRandomVariable, Simulator.TriangularRandomVariable, Simulator.UniformRandomVariable, and Simulator.WeibullRandomVariable.

double Simulator.IRandomVariable.getPercentile ( double n )

Provide the value that represents the nth percentile from the data contained in this variable. Most useful for empirical data.

Parameters:

n	A number between 0 and 100.

Returns:

Implemented in Simulator.ConstantRandomVariable, Simulator.EmpiricalRandomVariable, Simulator.ErlangRandomVariable, Simulator.ExponentialRandomVariable, Simulator.NormalRandomVariable, Simulator.PoissonRandomVariable, Simulator.TriangularRandomVariable, Simulator.UniformRandomVariable, and Simulator.WeibullRandomVariable.

double Simulator.IRandomVariable.getStddev ( )

Return the standard deviation of this variable. For empirical variables, standard deviation is calculated using the population variance (not a sample variance).

Returns:

Implemented in Simulator.ConstantRandomVariable, Simulator.EmpiricalRandomVariable, Simulator.ErlangRandomVariable, Simulator.ExponentialRandomVariable, Simulator.NormalRandomVariable, Simulator.PoissonRandomVariable, Simulator.TriangularRandomVariable, Simulator.UniformRandomVariable, and Simulator.WeibullRandomVariable.

string Simulator.IRandomVariable.getStringDescription ( )

Return a string representation of this random variable. This description could be fed back into RandomVariableFactory.create() to produce a duplicate of this variable.