Package com.opttek.optquest

Class COptQuestCauchyRandomVariable

java.lang.Object

com.opttek.optquest.COptQuestVariable

com.opttek.optquest.COptQuestUserControlledVariable

com.opttek.optquest.COptQuestCauchyRandomVariable

public class COptQuestCauchyRandomVariable
extends COptQuestUserControlledVariable

A random variable with a Cauchy distribution. The values spread symmetrically around location, which is the median. Values far from the median are much more likely than with a normal distribution, and the distribution has no mean. scale, which must be greater than 0, is the spread: half of the values are within scale of location.

The engine draws a new value at the start of every replication. The probability distribution is COptQuestCauchyDistribution.

See Also:

• OptQuestModel.AddCauchyRandomVariable(String, double, double)
• COptQuestCauchyDistribution

Constructor Summary

Constructors

Constructor	Description
COptQuestCauchyRandomVariable(String name, double location, double scale)	Constructs a new Cauchy random variable with the specified name, location, and scale parameters.

Method Summary

Methods inherited from class com.opttek.optquest.COptQuestUserControlledVariable

GetReplicationStatistic, GetReplicationStatisticValue, SetExclusiveRange, SetLowerBound, SetReplicationStatistic, SetUpperBound

Methods inherited from class com.opttek.optquest.COptQuestVariable

equals, GetDOELowerBound, GetDOEUpperBound, GetExclusiveLowerBoundAt, GetExclusiveUpperBoundAt, getID, GetLowerBound, GetName, GetNumberOfExclusiveRanges, GetStepSize, GetSuggestedValue, GetUpperBound, getVarRange, hashCode, isZeroOne, SetName

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

COptQuestCauchyRandomVariable

public COptQuestCauchyRandomVariable(String name,
 double location,
 double scale)
                              throws COptQuestException

Constructs a new Cauchy random variable with the specified name, location, and scale parameters.

Parameters:

name - the name/identifier of this random variable (used for reporting, logging, or display purposes)

location - the location parameter (median and mode of the distribution)

scale - the scale parameter (the spread; must be positive)

Throws:

COptQuestException