squidpony.squidmath

Class IDistribution.SimpleDistribution

java.lang.Object

squidpony.squidmath.IDistribution.SimpleDistribution

All Implemented Interfaces:

IDistribution

Direct Known Subclasses:

BathtubDistribution, CurvedBoundedDistribution, SpikeDistribution.SimpleSpikeDistribution

Enclosing interface:

IDistribution

public abstract static class IDistribution.SimpleDistribution
extends java.lang.Object
implements IDistribution

An abstract IDistribution that always has a lower bound of 0.0 and an upper bound of IDistribution.EXCLUSIVE_ONE, matching the bounds of IRNG.nextDouble(). This provides methods to create SimpleDistribution instances from arbitrary IDistribution instances.

Nested Class Summary

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

IDistribution.SimpleDistribution

Field Summary

Fields inherited from interface squidpony.squidmath.IDistribution

EXCLUSIVE_ONE, EXCLUSIVE_ZERO

Constructor Summary

Constructors

Constructor and Description
SimpleDistribution()

Method Summary

Modifier and Type	Method and Description
static IDistribution.SimpleDistribution	clampedDistribution(IDistribution otherDistribution) Makes a new SimpleDistribution implementation given any IDistribution (typically one with large or infinite bounds) by simply clamping results that are below 0 to 0 and at least 1 to 0.9999999999999999 (the largest double less than 1.0 than can be represented).
static IDistribution.SimpleDistribution	fractionalDistribution(IDistribution otherDistribution) Makes a new SimpleDistribution implementation given any IDistribution (typically one with large or infinite bounds) by getting the fractional component of a result from otherDistribution.
static IDistribution.SimpleDistribution	fractionalOffsetDistribution(IDistribution otherDistribution, double offset) Makes a new SimpleDistribution implementation given any IDistribution (typically one with large or infinite bounds) by getting the fractional component of offset plus a result from otherDistribution.
double	getLowerBound() Gets the lower inclusive bound, which is 0.0.
double	getMean() Gets the mean value of this distribution, which by default is Double.NaN.
double	getUpperBound() Gets the upper inclusive bound of the distribution, which is 0.9999999999999999 (IDistribution.EXCLUSIVE_ONE).

Methods inherited from class java.lang.Object

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

Methods inherited from interface squidpony.squidmath.IDistribution

nextDouble

Constructor Detail

SimpleDistribution

public SimpleDistribution()

Method Detail

fractionalDistribution

public static IDistribution.SimpleDistribution fractionalDistribution(IDistribution otherDistribution)

Makes a new SimpleDistribution implementation given any IDistribution (typically one with large or infinite bounds) by getting the fractional component of a result from otherDistribution.

Parameters:

otherDistribution - any other IDistribution

Returns:

a new anonymous implementation of SimpleDistribution that gets the fractional part of otherDistribution.

fractionalOffsetDistribution

public static IDistribution.SimpleDistribution fractionalOffsetDistribution(IDistribution otherDistribution,
                                                                            double offset)

Makes a new SimpleDistribution implementation given any IDistribution (typically one with large or infinite bounds) by getting the fractional component of offset plus a result from otherDistribution. Using the offset allows distributions like GaussianDistribution, which are centered on 0.0, to become centered halfway on 0.5, making the result of this distribution have a Gaussian-like peak on 0.5 instead of peaking at the bounds when offset is 0.0.

Parameters:

otherDistribution - any other IDistribution

Returns:

a new anonymous implementation of SimpleDistribution that gets the fractional part of otherDistribution.

clampedDistribution

public static IDistribution.SimpleDistribution clampedDistribution(IDistribution otherDistribution)

Makes a new SimpleDistribution implementation given any IDistribution (typically one with large or infinite bounds) by simply clamping results that are below 0 to 0 and at least 1 to 0.9999999999999999 (the largest double less than 1.0 than can be represented). This will behave very oddly for distributions that are centered on 0.0; for those you probably want fractionalOffsetDistribution(IDistribution, double).

Parameters:

otherDistribution - any other IDistribution

Returns:

a new anonymous implementation of SimpleDistribution that clamps otherDistribution in range.

getLowerBound

public double getLowerBound()

Gets the lower inclusive bound, which is 0.0.

Specified by:

getLowerBound in interface IDistribution

Returns:

the lower inclusive bound of the distribution, 0.0

getUpperBound

public double getUpperBound()

Gets the upper inclusive bound of the distribution, which is 0.9999999999999999 (IDistribution.EXCLUSIVE_ONE).

Specified by:

getUpperBound in interface IDistribution

Returns:

the upper inclusive bound of the distribution, 0.9999999999999999

getMean

public double getMean()

Gets the mean value of this distribution, which by default is Double.NaN. Implementing classes are strongly advised to override this and provide a meaningful estimate (at least) of the mean.

Specified by:

getMean in interface IDistribution

Returns:

the mean value of this distribution (by default, Double.NaN)