Apache Commons Math 3.6.1 · org.apache.commons.math3.distribution.IntegerDistribution

Method Summary

Modifier and Type	Method and Description
public double	Returns: the probability that a random variable with this distribution takes a value less than or equal to `x` cumulativeProbability(int the point at which the CDF is evaluated x) For a random variable `X` whose values are distributed according to this distribution, this method returns `P(X <= x)`.
public double	Returns: the probability that a random variable with this distribution will take a value between `x0` and `x1`, excluding the lower and including the upper endpoint cumulativeProbability(int the exclusive lower bound x0, int the inclusive upper bound x1) For a random variable `X` whose values are distributed according to this distribution, this method returns `P(x0 < X <= x1)`.
public double	Returns: the mean or `Double.NaN` if it is not defined getNumericalMean() Use this method to get the numerical value of the mean of this distribution.
public double	Returns: the variance (possibly `Double.POSITIVE_INFINITY` or `Double.NaN` if it is not defined) getNumericalVariance() Use this method to get the numerical value of the variance of this distribution.
public int	Returns: lower bound of the support (`Integer.MIN_VALUE` for negative infinity) getSupportLowerBound() Access the lower bound of the support.
public int	Returns: upper bound of the support (`Integer.MAX_VALUE` for positive infinity) getSupportUpperBound() Access the upper bound of the support.
public int	Returns: the smallest `p`-quantile of this distribution (largest 0-quantile for `p = 0`) inverseCumulativeProbability(double the cumulative probability p) Computes the quantile function of this distribution.
public boolean	Returns: whether the support is connected or not isSupportConnected() Use this method to get information about whether the support is connected, i.e. whether all integers between the lower and upper bound of the support are included in the support.
public double	Returns: the value of the probability mass function at `x` probability(int the point at which the PMF is evaluated x) For a random variable `X` whose values are distributed according to this distribution, this method returns `P(X = x)`.
public void	reseedRandomGenerator(long the new seed seed) Reseed the random generator used to generate samples.
public int	Returns: a random value sample() Generate a random value sampled from this distribution.
public int[]	Returns: an array representing the random sample sample(int the number of random values to generate sampleSize) Generate a random sample from the distribution.

Method Detail

cumulativeProbability back to summary

cumulativeProbability	back to summary
public double cumulativeProbability(int x) For a random variable `X` whose values are distributed according to this distribution, this method returns `P(X <= x)`. In other words, this method represents the (cumulative) distribution function (CDF) for this distribution. Parameters x:int the point at which the CDF is evaluated Returns:double the probability that a random variable with this distribution takes a value less than or equal to `x`

public double cumulativeProbability(int x)

For a random variable X whose values are distributed according to this distribution, this method returns P(X <= x). In other words, this method represents the (cumulative) distribution function (CDF) for this distribution.

Parameters

x:int: the point at which the CDF is evaluated

Returns:double

the probability that a random variable with this distribution takes a value less than or equal to x

cumulativeProbability back to summary

cumulativeProbability	back to summary
public double cumulativeProbability(int x0, int x1) throws NumberIsTooLargeException For a random variable `X` whose values are distributed according to this distribution, this method returns `P(x0 < X <= x1)`. Parameters x0:int the exclusive lower bound x1:int the inclusive upper bound Returns:double the probability that a random variable with this distribution will take a value between `x0` and `x1`, excluding the lower and including the upper endpoint Exceptions NumberIsTooLargeException: if `x0 > x1`

public double cumulativeProbability(int x0, int x1) throws NumberIsTooLargeException

For a random variable X whose values are distributed according to this distribution, this method returns P(x0 < X <= x1).

Parameters

x0:int: the exclusive lower bound
x1:int: the inclusive upper bound

Returns:double

the probability that a random variable with this distribution will take a value between x0 and x1, excluding the lower and including the upper endpoint

Exceptions

NumberIsTooLargeException:: if x0 > x1

getNumericalMean back to summary

getNumericalMean	back to summary
public double getNumericalMean() Use this method to get the numerical value of the mean of this distribution. Returns:double the mean or `Double.NaN` if it is not defined

public double getNumericalMean()

Use this method to get the numerical value of the mean of this distribution.

Returns:double: the mean or Double.NaN if it is not defined

getNumericalVariance back to summary

getNumericalVariance	back to summary
public double getNumericalVariance() Use this method to get the numerical value of the variance of this distribution. Returns:double the variance (possibly `Double.POSITIVE_INFINITY` or `Double.NaN` if it is not defined)

public double getNumericalVariance()

Use this method to get the numerical value of the variance of this distribution.

Returns:double: the variance (possibly Double.POSITIVE_INFINITY or Double.NaN if it is not defined)

getSupportLowerBound back to summary

getSupportLowerBound	back to summary
public int getSupportLowerBound() Access the lower bound of the support. This method must return the same value as `inverseCumulativeProbability(0)`. In other words, this method must return `inf {x in Z \| P(X <= x) > 0}`. Returns:int lower bound of the support (`Integer.MIN_VALUE` for negative infinity)

public int getSupportLowerBound()

Access the lower bound of the support. This method must return the same value as inverseCumulativeProbability(0). In other words, this method must return

inf {x in Z | P(X <= x) > 0}.

Returns:int: lower bound of the support (Integer.MIN_VALUE for negative infinity)

getSupportUpperBound back to summary

getSupportUpperBound	back to summary
public int getSupportUpperBound() Access the upper bound of the support. This method must return the same value as `inverseCumulativeProbability(1)`. In other words, this method must return `inf {x in R \| P(X <= x) = 1}`. Returns:int upper bound of the support (`Integer.MAX_VALUE` for positive infinity)

public int getSupportUpperBound()

Access the upper bound of the support. This method must return the same value as inverseCumulativeProbability(1). In other words, this method must return

inf {x in R | P(X <= x) = 1}.

Returns:int: upper bound of the support (Integer.MAX_VALUE for positive infinity)

inverseCumulativeProbability back to summary

inverseCumulativeProbability	back to summary
public int inverseCumulativeProbability(double p) throws OutOfRangeException Computes the quantile function of this distribution. For a random variable `X` distributed according to this distribution, the returned value is `inf{x in Z \| P(X<=x) >= p}` for `0 < p <= 1`, `inf{x in Z \| P(X<=x) > 0}` for `p = 0`. If the result exceeds the range of the data type `int`, then `Integer.MIN_VALUE` or `Integer.MAX_VALUE` is returned. Parameters p:double the cumulative probability Returns:int the smallest `p`-quantile of this distribution (largest 0-quantile for `p = 0`) Exceptions OutOfRangeException: if `p < 0` or `p > 1`

public int inverseCumulativeProbability(double p) throws OutOfRangeException

Computes the quantile function of this distribution. For a random variable X distributed according to this distribution, the returned value is

inf{x in Z | P(X<=x) >= p} for 0 < p <= 1,
inf{x in Z | P(X<=x) > 0} for p = 0.

If the result exceeds the range of the data type int, then Integer.MIN_VALUE or Integer.MAX_VALUE is returned.

Parameters

p:double: the cumulative probability

Returns:int

the smallest p-quantile of this distribution (largest 0-quantile for p = 0)

Exceptions

OutOfRangeException:: if p < 0 or p > 1

isSupportConnected	back to summary
public boolean isSupportConnected() Use this method to get information about whether the support is connected, i.e. whether all integers between the lower and upper bound of the support are included in the support. Returns:boolean whether the support is connected or not

isSupportConnected

back to summary

public boolean isSupportConnected()

Use this method to get information about whether the support is connected, i.e. whether all integers between the lower and upper bound of the support are included in the support.

Returns:boolean: whether the support is connected or not

probability back to summary

probability	back to summary
public double probability(int x) For a random variable `X` whose values are distributed according to this distribution, this method returns `P(X = x)`. In other words, this method represents the probability mass function (PMF) for the distribution. Parameters x:int the point at which the PMF is evaluated Returns:double the value of the probability mass function at `x`

public double probability(int x)

For a random variable X whose values are distributed according to this distribution, this method returns P(X = x). In other words, this method represents the probability mass function (PMF) for the distribution.

Parameters

x:int: the point at which the PMF is evaluated

Returns:double

the value of the probability mass function at x

reseedRandomGenerator	back to summary
public void reseedRandomGenerator(long seed) Reseed the random generator used to generate samples. Parameters seed:long the new seed Since 3.0

reseedRandomGenerator

back to summary

public void reseedRandomGenerator(long seed)

Reseed the random generator used to generate samples.

Parameters

seed:long: the new seed

Since

3.0

sample	back to summary
public int sample() Generate a random value sampled from this distribution. Returns:int a random value Since 3.0

sample

back to summary

public int sample()

Generate a random value sampled from this distribution.

Returns:int: a random value
Since: 3.0

sample back to summary

sample	back to summary
public int[] sample(int sampleSize) Generate a random sample from the distribution. Parameters sampleSize:int the number of random values to generate Returns:int[] an array representing the random sample Exceptions NotStrictlyPositiveException: if `sampleSize` is not positive Since 3.0

public int[] sample(int sampleSize)

Generate a random sample from the distribution.

Parameters

sampleSize:int: the number of random values to generate

Returns:int[]

an array representing the random sample

Exceptions

NotStrictlyPositiveException:: if sampleSize is not positive

Since

3.0

public Interface IntegerDistribution

Method Summary

Method Detail