Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
public final class StatUtils {

/** percentile. */
private static final Quantile QUANTILE = Quantile.withDefaults().with(EstimationMethod.HF6).withCopy(false);
private static final Quantile QUANTILE = Quantile.withDefaults().with(EstimationMethod.HF6).withCopy(true);

/**
* Private Constructor.
Expand Down Expand Up @@ -477,6 +477,13 @@ public static double min(final double[] values, final int begin, final int lengt
* </ul>
* <p>
* See Commons Statistics {@link Quantile} for a description of the percentile estimation algorithm used.
* <p>
* The percentile is computed on a copy of the input so the order of
* <code>values</code> is not changed. The copy is made on every call. To
* compute several percentiles of the same data use a single call of
* {@link Quantile#evaluate(double[], double...)} with all the probabilities
* (scaled from 0 - 1), using {@link EstimationMethod#HF6} to match this method,
* and {@link Quantile#withCopy(boolean) withCopy(false)} if the input may be reordered.
*
* @param values input array of values
* @param p the percentile value to compute
Expand Down Expand Up @@ -504,6 +511,14 @@ public static double percentile(final double[] values, final double p) throws Ma
* </ul>
* <p>
* See Commons Statistics {@link Quantile} for a description of the percentile estimation algorithm used.
* <p>
* The percentile is computed on a copy of the specified range so the order of
* <code>values</code> is not changed. The copy is made on every call. To
* compute several percentiles of the same data use a single call of
* {@link Quantile#evaluateRange(double[], int, int, double...)} with all the
* probabilities (scaled from 0 - 1), using {@link EstimationMethod#HF6} to match
* this method, and {@link Quantile#withCopy(boolean) withCopy(false)} if the input
* may be reordered.
*
* @param values array of input values
* @param p the percentile to compute
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -437,6 +437,23 @@ public double getElement(int index) {
* <li>at least one value must be stored (returns <code>Double.NaN
* </code> otherwise)</li>
* </ul>
* <p>
* The default implementation computes the percentile on a copy of the
* stored values so the order returned by {@link #getValues()} is preserved.
* The copy and the selection are repeated on every call, even if the stored
* values have not changed. To compute several percentiles of the same data,
* get the values once and pass all the probabilities (scaled from 0 - 1) to
* a single call of Commons Statistics
* {@link org.apache.commons.statistics.descriptive.Quantile#evaluate(double[], double...)
* Quantile.evaluate}. The same estimation as this method is obtained with:
* <pre>
* Quantile.withDefaults()
* .with(Quantile.EstimationMethod.HF6)
* .withCopy(false)
* .evaluate(stats.getValues(), 0.25, 0.5, 0.75);
* </pre>
* <p>
* {@code withCopy(false)} is safe here since {@link #getValues()} returns a copy.
*
* @param p the requested percentile (scaled from 0 - 100)
* @return An estimate for the pth percentile of the stored data
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@ static Sum getInstance() {
static final class Percentile implements UnivariateStatistic {
/** Delegate percentile implementation. */
private static final Quantile QUANTILE =
Quantile.withDefaults().with(EstimationMethod.HF6).withCopy(false);
Quantile.withDefaults().with(EstimationMethod.HF6).withCopy(true);

/** Probability. */
private double p;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -456,6 +456,14 @@ public void testPercentile() {
TestUtils.assertEquals(2.5, StatUtils.percentile(x, 1, 3, 62.5), TOLERANCE);
}

@Test
public void testPercentileDoesNotModifyInput() {
final double[] x = {THREE, ONE, TWO, TWO};
StatUtils.percentile(x, 50);
StatUtils.percentile(x, 1, 3, 50);
Assert.assertArrayEquals(new double[] {THREE, ONE, TWO, TWO}, x, 0);
}

@Test
public void testDifferenceStats() {
double sample1[] = {1d, 2d, 3d, 4d};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,22 @@ public void testGetValues() {
Assert.assertEquals(12.0, stats.getElement(88), 1.0e-10);
}

@Test
public void testPercentileDoesNotReorderValues() {
DescriptiveStatistics stats = createDescriptiveStatistics();
stats.setWindowSize(5);
for (double v : new double[] {5, 4, 3, 2, 1}) {
stats.addValue(v);
}
Assert.assertEquals(3, stats.getPercentile(50), 0);
// toString() reports the median
Assert.assertNotNull(stats.toString());
Assert.assertArrayEquals(new double[] {5, 4, 3, 2, 1}, stats.getValues(), 0);
// The oldest value is discarded
stats.addValue(100);
Assert.assertArrayEquals(new double[] {4, 3, 2, 1, 100}, stats.getValues(), 0);
}

@Test
public void testQuadraticMean() {
final double[] values = { 1.2, 3.4, 5.6, 7.89 };
Expand Down
Loading