Apache
/
commons-math
mirror of https://github.com/apache/commons-math.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

In o.a.c.m3.distribution.GammaDistribution 

- deprecated getAlpha() and created getShape()
  - deprecated getBeta() and created getScale().
See MATH-791.


git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@1342404 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Sebastien Brisard 2012-05-24 19:23:37 +00:00
parent dde021f1ee
commit b203596f1e
1 changed files with 28 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
src/main/java/org/apache/commons/math3/distribution/GammaDistribution.java
View File

@ -36,7 +36,7 @@ public class GammaDistribution extends AbstractRealDistribution {
public static final double DEFAULT_INVERSE_ABSOLUTE_ACCURACY = 1e-9;
/** Serializable version identifier. */
private static final long serialVersionUID = 20120522L;
private static final long serialVersionUID = 20120524L;
/** The shape parameter. */
private final double shape;
@ -104,7 +104,7 @@ public class GammaDistribution extends AbstractRealDistribution {
*
* @param shape the shape parameter
* @param scale the scale parameter
* @param inverseCumAccuracy the aximum absolute error in inverse
* @param inverseCumAccuracy the maximum absolute error in inverse
* cumulative probability estimates (defaults to
* {@link #DEFAULT_INVERSE_ABSOLUTE_ACCURACY}).
* @throws NotStrictlyPositiveException if {@code shape <= 0} or
@ -114,10 +114,10 @@ public class GammaDistribution extends AbstractRealDistribution {
public GammaDistribution(double shape, double scale, double inverseCumAccuracy)
throws NotStrictlyPositiveException {
if (shape <= 0) {
throw new NotStrictlyPositiveException(LocalizedFormats.ALPHA, shape);
throw new NotStrictlyPositiveException(LocalizedFormats.SHAPE, shape);
}
if (scale <= 0) {
throw new NotStrictlyPositiveException(LocalizedFormats.BETA, scale);
throw new NotStrictlyPositiveException(LocalizedFormats.SCALE, scale);
}
this.shape = shape;
@ -137,20 +137,42 @@ public class GammaDistribution extends AbstractRealDistribution {
* Returns the shape parameter of {@code this} distribution.
*
* @return the shape parameter
* @deprecated as of version 3.1, {@link #getShape()} should be preferred.
* This method will be removed in version 4.0.
*/
public double getAlpha() {
return shape;
}
/**
* Returns the shape parameter of {@code this} distribution.
*
* @return the shape parameter
*/
public double getShape() {
return shape;
}
/**
* Returns the scale parameter of {@code this} distribution.
*
* @return the scale parameter
* @deprecated as of version 3.1, {@link #getScale()} should be preferred.
* This method will be removed in version 4.0.
*/
public double getBeta() {
return scale;
}
/**
* Returns the scale parameter of {@code this} distribution.
*
* @return the scale parameter
*/
public double getScale() {
return scale;
}
/**
* {@inheritDoc}
*
@ -262,7 +284,7 @@ public class GammaDistribution extends AbstractRealDistribution {
* mean is {@code alpha * beta}.
*/
public double getNumericalMean() {
return getAlpha() * getBeta();
return shape * scale;
}
/**
@ -274,8 +296,7 @@ public class GammaDistribution extends AbstractRealDistribution {
* @return {@inheritDoc}
*/
public double getNumericalVariance() {
final double b = getBeta();
return getAlpha() * b * b;
return shape * scale * scale;
}
/**