com.threerings.probs
Class FloatVariable.Exponential

java.lang.Object
  com.threerings.util.DeepObject
      com.threerings.probs.FloatVariable
          com.threerings.probs.FloatVariable.Exponential

All Implemented Interfaces:

Exportable, Copyable, Cloneable

Enclosing class:

FloatVariable

public static class FloatVariable.Exponential
extends FloatVariable

Returns an exponentially distributed value.

Nested Class Summary

Nested classes/interfaces inherited from class com.threerings.probs.FloatVariable

FloatVariable.Constant, FloatVariable.Exponential, FloatVariable.Normal, FloatVariable.Uniform

Field Summary

float

mean The mean value.

Constructor Summary

FloatVariable.Exponential()
No-arg constructor for deserialization, etc.

FloatVariable.Exponential(float mean)
Creates an exponentially distributed variable with the specified mean.

FloatVariable.Exponential(FloatVariable variable)
Creates an exponentially distributed variable with the specified variable's mean.

Method Summary

float	getMean() Returns the variable's mean.
float	getValue() Returns a sample value according to the variable's distribution.

Methods inherited from class com.threerings.util.DeepObject

clone, copy, copy, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

mean

@Editable(min=-1d/0d,
          max=-1d/0d,
          step=-1d/0d,
          scale=-1d/0d)
public float mean

The mean value.

Constructor Detail

FloatVariable.Exponential

public FloatVariable.Exponential(float mean)

Creates an exponentially distributed variable with the specified mean.

FloatVariable.Exponential

public FloatVariable.Exponential(FloatVariable variable)

Creates an exponentially distributed variable with the specified variable's mean.

FloatVariable.Exponential

public FloatVariable.Exponential()

No-arg constructor for deserialization, etc.

Method Detail

getValue

public float getValue()

Description copied from class: FloatVariable

Returns a sample value according to the variable's distribution.

Specified by:

getValue in class FloatVariable

getMean

public float getMean()

Description copied from class: FloatVariable

Returns the variable's mean.

Specified by:

getMean in class FloatVariable