io.virtdata.continuous.long_double

Class Cauchy

java.lang.Object

io.virtdata.continuous.long_double.LongToDoubleContinuousCurve

io.virtdata.continuous.long_double.Cauchy

All Implemented Interfaces:

LongToDoubleFunction

public class Cauchy
extends LongToDoubleContinuousCurve

Generate samples according to the specified probability density. The input value consists of a long between 0L and Long.MAX_VALUE. This value is scaled to the unit interval (0.0, 1.0) as an index into a sampling function. The method used is inverse cumulative density sampling.

Sampling Mode

The curve can be sampled in either map or hash mode. Map mode simply indexes into the probability curve in the order that it would appear on a density plot. Hash mode applies a murmur3 hash to the input value before scaling from the range of longs to the unit interval, thus providing a pseudo-random sample of a value from the curve. This is usually what you want, so hash mode is the default. To enable map mode, simply provide "map" as one of the modifiers as explained below.

Interpolation

The curve can be computed from the sampling function for each value generated, or it can be provided via interpolation with a lookup table. Using interpolation makes all the generator functions perform the same. This is almost always what you want, so interpolation is enabled by default. In order to compute the value for every sample instead, simply provide "compute" as one of the modifiers as explained below. You can add optional modifiers after the distribution parameters. You can add one of 'hash' or 'map' but not both. If neither of these is added, 'hash' is implied as a default. You can add one of 'interpolate' or 'compute' but not both. If neither of these is added, 'interpolate' is implied as a default. At times, it might be useful to add 'hash', 'interpolate' to your specifiers as a form of verbosity or explicit specification.

See Also:

LongToDoubleContinuousCurve

Constructor Summary

Constructors

Constructor and Description
Cauchy(double median, double scale, String... mods)

Method Summary

Methods inherited from class io.virtdata.continuous.long_double.LongToDoubleContinuousCurve

applyAsDouble

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Cauchy

public Cauchy(double median,
              double scale,
              String... mods)