gov.sandia.cognition.statistics

Class AbstractClosedFormIntegerDistribution

java.lang.Object

gov.sandia.cognition.util.AbstractCloneableSerializable

gov.sandia.cognition.statistics.AbstractDistribution<NumberType>

gov.sandia.cognition.statistics.AbstractClosedFormUnivariateDistribution<java.lang.Number>

gov.sandia.cognition.statistics.AbstractClosedFormIntegerDistribution

All Implemented Interfaces:

Vectorizable, ClosedFormComputableDistribution<java.lang.Number>, ClosedFormDiscreteUnivariateDistribution<java.lang.Number>, ClosedFormDistribution<java.lang.Number>, ClosedFormUnivariateDistribution<java.lang.Number>, ComputableDistribution<java.lang.Number>, DiscreteDistribution<java.lang.Number>, Distribution<java.lang.Number>, DistributionWithMean<java.lang.Number>, IntegerDistribution, UnivariateDistribution<java.lang.Number>, CloneableSerializable, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

BernoulliDistribution, BetaBinomialDistribution, BinomialDistribution, GeometricDistribution, NegativeBinomialDistribution, PoissonDistribution, UniformIntegerDistribution, YuleSimonDistribution

public abstract class AbstractClosedFormIntegerDistribution
extends AbstractClosedFormUnivariateDistribution<java.lang.Number>
implements ClosedFormDiscreteUnivariateDistribution<java.lang.Number>, IntegerDistribution

An abstract class for closed-form integer distributions. Defines utility methods.

Since:

3.4.0

Author:

Justin Basilico

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractClosedFormIntegerDistribution() Creates a new AbstractClosedFormIntegerDistribution.

Method Summary

Modifier and Type	Method and Description
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 class gov.sandia.cognition.statistics.AbstractClosedFormUnivariateDistribution

clone

Methods inherited from class gov.sandia.cognition.statistics.AbstractDistribution

sample, sample

Methods inherited from class java.lang.Object

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

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

getCDF

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

getMaxSupport, getMeanAsDouble, getMinSupport, getVariance

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

getMean

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

sample, sample, sampleInto

Methods inherited from interface gov.sandia.cognition.math.matrix.Vectorizable

clone, convertFromVector, convertToVector

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

sampleAsInt

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

getDomain, getDomainSize, getProbabilityFunction

Constructor Detail

AbstractClosedFormIntegerDistribution

public AbstractClosedFormIntegerDistribution()

Creates a new AbstractClosedFormIntegerDistribution.

Method Detail

sampleAsInts

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

Description copied from interface: IntegerDistribution

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

Specified by:

sampleAsInts in interface IntegerDistribution

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

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

Description copied from interface: IntegerDistribution

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

Specified by:

sampleInto in interface IntegerDistribution

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.