squidpony.squidmath

Class KumaraswamyDistribution

java.lang.Object

squidpony.squidmath.KumaraswamyDistribution

All Implemented Interfaces:

IDistribution

public class KumaraswamyDistribution
extends java.lang.Object
implements IDistribution

A parameterized IDistribution that can be configured to take various shapes. See Wikipedia's article on this distribution for more.

Nested Class Summary

Nested classes/interfaces inherited from interface squidpony.squidmath.IDistribution

IDistribution.SimpleDistribution

Field Summary

Fields

Modifier and Type	Field and Description
static KumaraswamyDistribution	instance

Fields inherited from interface squidpony.squidmath.IDistribution

EXCLUSIVE_ONE, EXCLUSIVE_ZERO

Constructor Summary

Constructors

Constructor and Description
KumaraswamyDistribution()
KumaraswamyDistribution(double a, double b)

Method Summary

Modifier and Type	Method and Description
double	getA()
double	getB()
double	getLowerBound() Gets the lower inclusive bound of the distribution.
double	getMean() Gets the mean value of this distribution.
double	getUpperBound() Gets the upper inclusive bound of the distribution.
double	nextDouble(IRNG rng) Gets a double between getLowerBound() and getUpperBound() that obeys this distribution.
void	setA(double a)
void	setB(double b)

Methods inherited from class java.lang.Object

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

Field Detail

instance

public static final KumaraswamyDistribution instance

Constructor Detail

KumaraswamyDistribution

public KumaraswamyDistribution()

KumaraswamyDistribution

public KumaraswamyDistribution(double a,
                               double b)

Method Detail

getA

public double getA()

setA

public void setA(double a)

getB

public double getB()

setB

public void setB(double b)

getLowerBound

public double getLowerBound()

Description copied from interface: IDistribution

Gets the lower inclusive bound of the distribution. If the bound is exclusive above 0.0, then this will be IDistribution.EXCLUSIVE_ZERO.

Specified by:

getLowerBound in interface IDistribution

Returns:

the lower inclusive bound of the distribution

getUpperBound

public double getUpperBound()

Description copied from interface: IDistribution

Gets the upper inclusive bound of the distribution. If the bound is exclusive below 1.0, like IRNG.nextDouble()), then this will be IDistribution.EXCLUSIVE_ONE.

Specified by:

getUpperBound in interface IDistribution

Returns:

the upper inclusive bound of the distribution

nextDouble

public double nextDouble(IRNG rng)

Gets a double between getLowerBound() and getUpperBound() that obeys this distribution.

Specified by:

nextDouble in interface IDistribution

Parameters:

rng - an IRNG, such as RNG or GWTRNG, that this will get one or more random numbers from

Returns:

a double within the range of getLowerBound() and getUpperBound()

getMean

public double getMean()

Gets the mean value of this distribution.
Note that this particular implementation does some potentially-heavy calculations, and if the a and b parameters are unchanged, then this should be cached instead of repeatedly calculating it.

Specified by:

getMean in interface IDistribution

Returns:

the mean value of this distribution