net.openhft.chronicle.jlbh

Class PercentileSummary

java.lang.Object

net.openhft.chronicle.jlbh.PercentileSummary

public final class PercentileSummary
extends Object

Calculates values for the run summary.

Handle runs with differing number of samples (and hence, percentiles) correctly

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PercentileSummary.RowConsumer Consumer of summary rows

Constructor Summary

Constructors

Constructor and Description
PercentileSummary(boolean skipFirst, @NotNull List<double[]> percentileRuns, double[] percentiles) Constructor

Method Summary

Modifier and Type	Method and Description
double	calculateVariance(int percentileIndex) Calculate the variance between runs for a percentile
void	forEachRow(PercentileSummary.RowConsumer consumer) Execute a callback for every percentile row that contains at least one value
double	getPercentileForRun(int percentileIndex, int runIndex) Get the percentile measurement for a specific run
void	printSummary() Print out the summary (for debugging)

Methods inherited from class java.lang.Object

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

Constructor Detail

PercentileSummary

public PercentileSummary(boolean skipFirst,
                         @NotNull
                         @NotNull List<double[]> percentileRuns,
                         double[] percentiles)

Constructor

Parameters:

skipFirst - Whether to skip the value from the first run when calculating variance

percentileRuns - The values for the individual runs

percentiles - The percentiles to render (some may not be present in some runs)

Method Detail

printSummary

public void printSummary()

Print out the summary (for debugging)

percentiles down the Y axis, runs along the X axis, variance in last column

calculateVariance

public double calculateVariance(int percentileIndex)

Calculate the variance between runs for a percentile

Parameters:

percentileIndex - The index of the percentile for which to calculate the variance

Returns:

The variance for that percentile

getPercentileForRun

public double getPercentileForRun(int percentileIndex,
                                  int runIndex)

Get the percentile measurement for a specific run

Parameters:

percentileIndex - The index of the percentile to retrieve

runIndex - The index of the run to retrieve

Returns:

The latency for the percentile, or Double.POSITIVE_INFINITY if there are not enough samples for that

forEachRow

public void forEachRow(PercentileSummary.RowConsumer consumer)

Execute a callback for every percentile row that contains at least one value

Parameters:

consumer - A PercentileSummary.RowConsumer to process the rows