org.apache.commons.math.distribution
Class DistributionFactory

java.lang.Object
  org.apache.commons.math.distribution.DistributionFactory

Direct Known Subclasses:

DistributionFactoryImpl

Deprecated. pluggability of distribution instances is now provided through constructors and setters.

public abstract class DistributionFactory
extends java.lang.Object

This factory provids the means to create common statistical distributions. The following distributions are supported:

• Binomial
• Cauchy
• Chi-Squared
• Exponential
• F
• Gamma
• HyperGeometric
• Poisson
• Normal
• Student's t
• Weibull
• Pascal

Common usage:

 DistributionFactory factory = DistributionFactory.newInstance();

 // create a Chi-Square distribution with 5 degrees of freedom.
 ChiSquaredDistribution chi = factory.createChiSquareDistribution(5.0);
 

Version:

$Revision: 545192 $ $Date: 2007-06-07 07:35:04 -0700 (Thu, 07 Jun 2007) $

Constructor Summary

protected

DistributionFactory() Deprecated. Default constructor.

Method Summary

abstract BinomialDistribution	createBinomialDistribution(int numberOfTrials, double probabilityOfSuccess) Deprecated. Create a binomial distribution with the given number of trials and probability of success.
CauchyDistribution	createCauchyDistribution(double median, double scale) Deprecated. Create a new cauchy distribution with the given median and scale.
abstract ChiSquaredDistribution	createChiSquareDistribution(double degreesOfFreedom) Deprecated. Create a new chi-square distribution with the given degrees of freedom.
abstract ExponentialDistribution	createExponentialDistribution(double mean) Deprecated. Create a new exponential distribution with the given degrees of freedom.
abstract FDistribution	createFDistribution(double numeratorDegreesOfFreedom, double denominatorDegreesOfFreedom) Deprecated. Create a new F-distribution with the given degrees of freedom.
abstract GammaDistribution	createGammaDistribution(double alpha, double beta) Deprecated. Create a new gamma distribution with the given shape and scale parameters.
abstract HypergeometricDistribution	createHypergeometricDistribution(int populationSize, int numberOfSuccesses, int sampleSize) Deprecated. Create a new hypergeometric distribution with the given the population size, the number of successes in the population, and the sample size.
abstract NormalDistribution	createNormalDistribution() Deprecated. Create a new normal distribution with mean zero and standard deviation one.
abstract NormalDistribution	createNormalDistribution(double mean, double sd) Deprecated. Create a new normal distribution with the given mean and standard deviation.
PascalDistribution	createPascalDistribution(int numberOfSuccesses, double probabilityOfSuccess) Deprecated. Create a Pascal distribution with the given number of successes and probability of success.
abstract PoissonDistribution	createPoissonDistribution(double lambda) Deprecated. Create a new Poisson distribution with poisson parameter lambda.
abstract TDistribution	createTDistribution(double degreesOfFreedom) Deprecated. Create a new t distribution with the given degrees of freedom.
WeibullDistribution	createWeibullDistribution(double alpha, double beta) Deprecated. Create a new Weibull distribution with the given shape and scale parameters.
static DistributionFactory	newInstance() Deprecated. Create an instance of a DistributionFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

DistributionFactory

protected DistributionFactory()

Deprecated.

Default constructor.

Method Detail

newInstance

public static DistributionFactory newInstance()

Deprecated.

Create an instance of a DistributionFactory

Returns:

a new factory.

createBinomialDistribution

public abstract BinomialDistribution createBinomialDistribution(int numberOfTrials,
                                                                double probabilityOfSuccess)

Deprecated.

Create a binomial distribution with the given number of trials and probability of success.

Parameters:

numberOfTrials - the number of trials.

probabilityOfSuccess - the probability of success

Returns:

a new binomial distribution

createPascalDistribution

public PascalDistribution createPascalDistribution(int numberOfSuccesses,
                                                   double probabilityOfSuccess)

Deprecated.

Create a Pascal distribution with the given number of successes and probability of success.

Parameters:

numberOfSuccesses - the number of successes.

probabilityOfSuccess - the probability of success

Returns:

a new Pascal distribution

Since:

1.2

createCauchyDistribution

public CauchyDistribution createCauchyDistribution(double median,
                                                   double scale)

Deprecated.

Create a new cauchy distribution with the given median and scale.

Parameters:

median - the median of the distribution

scale - the scale

Returns:

a new cauchy distribution

Since:

1.1

createChiSquareDistribution

public abstract ChiSquaredDistribution createChiSquareDistribution(double degreesOfFreedom)

Deprecated.

Create a new chi-square distribution with the given degrees of freedom.

Parameters:

degreesOfFreedom - degrees of freedom

Returns:

a new chi-square distribution

createExponentialDistribution

public abstract ExponentialDistribution createExponentialDistribution(double mean)

Deprecated.

Create a new exponential distribution with the given degrees of freedom.

Parameters:

mean - mean

Returns:

a new exponential distribution

createFDistribution

public abstract FDistribution createFDistribution(double numeratorDegreesOfFreedom,
                                                  double denominatorDegreesOfFreedom)

Deprecated.

Create a new F-distribution with the given degrees of freedom.

Parameters:

numeratorDegreesOfFreedom - numerator degrees of freedom

denominatorDegreesOfFreedom - denominator degrees of freedom

Returns:

a new F-distribution

createGammaDistribution

public abstract GammaDistribution createGammaDistribution(double alpha,
                                                          double beta)

Deprecated.

Create a new gamma distribution with the given shape and scale parameters.

Parameters:

alpha - the shape parameter

beta - the scale parameter

Returns:

a new gamma distribution

createTDistribution

public abstract TDistribution createTDistribution(double degreesOfFreedom)

Deprecated.

Create a new t distribution with the given degrees of freedom.

Parameters:

degreesOfFreedom - degrees of freedom

Returns:

a new t distribution

createHypergeometricDistribution

public abstract HypergeometricDistribution createHypergeometricDistribution(int populationSize,
                                                                            int numberOfSuccesses,
                                                                            int sampleSize)

Deprecated.

Create a new hypergeometric distribution with the given the population size, the number of successes in the population, and the sample size.

Parameters:

populationSize - the population size

numberOfSuccesses - number of successes in the population

sampleSize - the sample size

Returns:

a new hypergeometric desitribution

createNormalDistribution

public abstract NormalDistribution createNormalDistribution(double mean,
                                                            double sd)

Deprecated.

Create a new normal distribution with the given mean and standard deviation.

Parameters:

mean - the mean of the distribution

sd - standard deviation

Returns:

a new normal distribution

createNormalDistribution

public abstract NormalDistribution createNormalDistribution()

Deprecated.

Create a new normal distribution with mean zero and standard deviation one.

Returns:

a new normal distribution.

createPoissonDistribution

public abstract PoissonDistribution createPoissonDistribution(double lambda)

Deprecated.

Create a new Poisson distribution with poisson parameter lambda.

Parameters:

lambda - poisson parameter

Returns:

a new poisson distribution.

createWeibullDistribution

public WeibullDistribution createWeibullDistribution(double alpha,
                                                     double beta)

Deprecated.

Create a new Weibull distribution with the given shape and scale parameters.

Parameters:

alpha - the shape parameter.

beta - the scale parameter.

Returns:

a new Weibull distribution.

Since:

1.1