org.apache.commons.math3
Class PerfTestUtils

java.lang.Object
  org.apache.commons.math3.PerfTestUtils

public class PerfTestUtils
extends Object

Simple benchmarking utilities.

NANO_TO_MILLI

public static final double NANO_TO_MILLI

Nanoseconds to milliseconds conversion factor (1.0E-6).

See Also:

Constant Field Values

PerfTestUtils

public PerfTestUtils()

time

public static StatisticalSummary[] time(int repeatChunk,
                                        int repeatStat,
                                        boolean runGC,
                                        Callable<Double>... methods)

Timing.

Parameters:

repeatChunk - Each timing measurement will done done for that number of repeats of the code.

repeatStat - Timing will be averaged over that number of runs.

runGC - Call System.gc() between each timed block. When set to true, the test will run much slower.

methods - Codes being timed.

Returns:

for each of the given methods, a StatisticalSummary of the average times (in milliseconds) taken by a single call to the call method (i.e. the time taken by each timed block divided by repeatChunk).

timesAndResults

public static double[][][] timesAndResults(int repeatChunk,
                                           int repeatStat,
                                           boolean runGC,
                                           Callable<Double>... methods)

Timing.

Parameters:

repeatChunk - Each timing measurement will done done for that number of repeats of the code.

repeatStat - Timing will be averaged over that number of runs.

runGC - Call System.gc() between each timed block. When set to true, the test will run much slower.

methods - Codes being timed.

Returns:

for each of the given methods (first dimension), and each of the repeatStat runs (second dimension):

• the average time (in milliseconds) taken by a single call to the call method (i.e. the time taken by each timed block divided by repeatChunk)
• the result returned by the call method.

timeAndReport

public static StatisticalSummary[] timeAndReport(String title,
                                                 int repeatChunk,
                                                 int repeatStat,
                                                 boolean runGC,
                                                 PerfTestUtils.RunTest... methods)

Timing and report (to standard output) the average time and standard deviation of a single call. The timing is performed by calling the time method.

Parameters:

title - Title of the test (for the report).

repeatChunk - Each timing measurement will done done for that number of repeats of the code.

repeatStat - Timing will be averaged over that number of runs.

runGC - Call System.gc() between each timed block. When set to true, the test will run much slower.

methods - Codes being timed.

Returns:

for each of the given methods, a statistics of the average times (in milliseconds) taken by a single call to the call method (i.e. the time taken by each timed block divided by repeatChunk).

timeAndReport

public static StatisticalSummary[] timeAndReport(String title,
                                                 PerfTestUtils.RunTest... methods)

Timing and report (to standard output). This method calls timeAndReport(title, 1000, 10000, false, methods).

Parameters:

title - Title of the test (for the report).

methods - Codes being timed.

Returns:

for each of the given methods, a statistics of the average times (in milliseconds) taken by a single call to the call method (i.e. the time taken by each timed block divided by repeatChunk).