squidpony.squidmath

Class SpikeDistribution.SimpleSpikeDistribution

java.lang.Object

squidpony.squidmath.IDistribution.SimpleDistribution

squidpony.squidmath.SpikeDistribution.SimpleSpikeDistribution

All Implemented Interfaces:

IDistribution

Enclosing class:

SpikeDistribution

public static class SpikeDistribution.SimpleSpikeDistribution
extends IDistribution.SimpleDistribution
implements IDistribution

A variant on SpikeDistribution that has its range shrunk and moved from [-1,1) to [0,1). It is a IDistribution.SimpleDistribution, and the spike is centered on 0.5.

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
SimpleSpikeDistribution()

Method Summary

Modifier and Type	Method and Description
double	getMean() Gets the mean value of this distribution (0.5).
double	nextDouble(IRNG rng) Gets a double between IDistribution.SimpleDistribution.getLowerBound() and IDistribution.SimpleDistribution.getUpperBound() that obeys this distribution.

Methods inherited from class squidpony.squidmath.IDistribution.SimpleDistribution

clampedDistribution, fractionalDistribution, fractionalOffsetDistribution, getLowerBound, getUpperBound

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

getLowerBound, getUpperBound

Constructor Detail

SimpleSpikeDistribution

public SimpleSpikeDistribution()

Method Detail

nextDouble

public double nextDouble(IRNG rng)

Gets a double between IDistribution.SimpleDistribution.getLowerBound() and IDistribution.SimpleDistribution.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 IDistribution.SimpleDistribution.getLowerBound() and IDistribution.SimpleDistribution.getUpperBound()

getMean

public double getMean()

Gets the mean value of this distribution (0.5).

Specified by:

getMean in interface IDistribution

Overrides:

getMean in class IDistribution.SimpleDistribution

Returns:

the mean value of this distribution (0.5)