gov.sandia.cognition.statistics

Interface IntegerDistribution

All Superinterfaces:

java.lang.Cloneable, CloneableSerializable, ComputableDistribution<java.lang.Number>, DiscreteDistribution<java.lang.Number>, Distribution<java.lang.Number>, DistributionWithMean<java.lang.Number>, java.io.Serializable, UnivariateDistribution<java.lang.Number>

All Known Implementing Classes:

AbstractClosedFormIntegerDistribution, BernoulliDistribution, BernoulliDistribution.CDF, BernoulliDistribution.PMF, BetaBinomialDistribution, BetaBinomialDistribution.CDF, BetaBinomialDistribution.PMF, BinomialDistribution, BinomialDistribution.CDF, BinomialDistribution.PMF, GeometricDistribution, GeometricDistribution.CDF, GeometricDistribution.PMF, NegativeBinomialDistribution, NegativeBinomialDistribution.CDF, NegativeBinomialDistribution.PMF, PoissonDistribution, PoissonDistribution.CDF, PoissonDistribution.PMF, UniformIntegerDistribution, UniformIntegerDistribution.CDF, UniformIntegerDistribution.PMF, YuleSimonDistribution, YuleSimonDistribution.CDF, YuleSimonDistribution.PMF

public interface IntegerDistribution
extends UnivariateDistribution<java.lang.Number>, DiscreteDistribution<java.lang.Number>

Defines a distribution over natural numbers. It is defined as a distribution over Number because the mean may itself not be an integer. However, it provides a way to get samples as integers.

Since:

3.4.0

Author:

Justin Basilico

Method Summary

Modifier and Type	Method and Description
int	sampleAsInt(java.util.Random random) Draws a single random sample from the distribution as an int.
int[]	sampleAsInts(java.util.Random random, int sampleCount) Samples values from this distribution as an array of ints.
void	sampleInto(java.util.Random random, int[] output, int start, int length) Samples values from this distribution as an array of ints.

Methods inherited from interface gov.sandia.cognition.statistics.UnivariateDistribution

getCDF, getMaxSupport, getMeanAsDouble, getMinSupport, getVariance

Methods inherited from interface gov.sandia.cognition.statistics.DistributionWithMean

getMean

Methods inherited from interface gov.sandia.cognition.statistics.DiscreteDistribution

getDomain, getDomainSize, getProbabilityFunction

Methods inherited from interface gov.sandia.cognition.statistics.Distribution

sample, sample, sampleInto

Methods inherited from interface gov.sandia.cognition.util.CloneableSerializable

clone

Method Detail

sampleAsInt

int sampleAsInt(java.util.Random random)

Draws a single random sample from the distribution as an int.

Parameters:

random - The random number generator to use.

Returns:

A sample from the distribution.

sampleAsInts

int[] sampleAsInts(java.util.Random random,
                   int sampleCount)

Samples values from this distribution as an array of ints. This is a convenience method to potentially avoid boxing.

Parameters:

random - Random number generator to use.

sampleCount - The number of values to sample. Cannot be negative

Returns:

An array of values sampled from this distribution. Size is that of count.

sampleInto

void sampleInto(java.util.Random random,
                int[] output,
                int start,
                int length)

Samples values from this distribution as an array of ints. This is a convenience method to potentially avoid boxing.

Parameters:

random - Random number generator to use.

output - The array to write the result into. Cannot be null.

start - The offset in the array to start writing at. Cannot be negative.

length - The number of values to sample. Cannot be negative.