fr.cnes.sirius.patrius.utils

Class TimeIt

java.lang.Object

fr.cnes.sirius.patrius.utils.TimeIt

public class TimeIt
extends Object

This class allows to perform a benchmark of a runnable function.

Author:

veuillh

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_NB_RUNS Default number of runs.
static long	DEFAULT_WARMUP_FACTOR Default warmup factor.

Constructor Summary

Constructors

Constructor and Description
TimeIt(Runnable benchmarkFunction) Simple constructor that defines automatically the number of loops that should be performed.
TimeIt(Runnable benchmarkFunction, long nbLoops, int nbRuns, boolean warmup) Main constructor.
TimeIt(Runnable benchmarkFunction, long nbLoops, int nbRuns, long nbWarmupLoops) Main constructor.

Method Summary

Modifier and Type	Method and Description
double	getMaxTime() Returns the maximum time it takes to perform the function to benchmark (evaluated on a batch of N loops).
double	getMeanTime() Returns the arithmetic mean of the computation time it takes to perform the function to benchmark (evaluated on a batch of N loops).
double	getMinTime() Returns the minimum computation time it takes to perform the function to benchmark (evaluated on a batch of N loops).
double	getStandardDeviationTime() Returns the standard deviation of the computation time it takes to perform the function to benchmark (evaluated on a batch of N loops).
double[]	getTimes() Returns the computation times it takes to perform the function to benchmark on each batch of "nbLoops" runs.
static double	loopsPerSecondEstimator(Runnable benchmarkFunction) Estimates very approximately the number of loops per seconds that can be done by the provided function.
String	toString() Returns a string representation of the benchmark evaluation statistical results.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NB_RUNS

public static final int DEFAULT_NB_RUNS

Default number of runs.

See Also:

Constant Field Values

DEFAULT_WARMUP_FACTOR

public static final long DEFAULT_WARMUP_FACTOR

Default warmup factor.

See Also:

Constant Field Values

Constructor Detail

TimeIt

public TimeIt(Runnable benchmarkFunction)

Simple constructor that defines automatically the number of loops that should be performed.

It chooses the number of loops so that each of the 7 runs will take around 1 second.

Parameters:

benchmarkFunction - The function to benchmark

TimeIt

public TimeIt(Runnable benchmarkFunction,
              long nbLoops,
              int nbRuns,
              boolean warmup)

Main constructor.

The function to benchmark will be evaluated nbLoops * nbRuns times.
If the function needs to warmup, it is previously run nbLoops / 10 times which are not taken in account for the statistics.

Parameters:

benchmarkFunction - The function to benchmark

nbLoops - The number of loops to be performed

nbRuns - The number of runs to be performed (used for the statistics)

warmup - true if the function needs to warmup, false otherwise

TimeIt

public TimeIt(Runnable benchmarkFunction,
              long nbLoops,
              int nbRuns,
              long nbWarmupLoops)

Main constructor.

The function to benchmark will be evaluated nbLoops * nbRuns times.
If the function needs to warmup, it is previously run nbWarmupLoops times which are not taken in account for the statistics.

Parameters:

benchmarkFunction - The function to benchmark

nbLoops - The number of loops to be performed

nbRuns - The number of runs to be performed (used for the statistics)

nbWarmupLoops - The number of loops to be performed for warmup the function (should be > 0 to enable to warmup)

Method Detail

getMeanTime

public double getMeanTime()

Returns the arithmetic mean of the computation time it takes to perform the function to benchmark (evaluated on a batch of N loops).

Returns:

the mean

getStandardDeviationTime

public double getStandardDeviationTime()

Returns the standard deviation of the computation time it takes to perform the function to benchmark (evaluated on a batch of N loops).

Returns:

the standard deviation

getMinTime

public double getMinTime()

Returns the minimum computation time it takes to perform the function to benchmark (evaluated on a batch of N loops).

Returns:

the minimum computation time

getMaxTime

public double getMaxTime()

Returns the maximum time it takes to perform the function to benchmark (evaluated on a batch of N loops).

Returns:

the maximum computation time

getTimes

public double[] getTimes()

Returns the computation times it takes to perform the function to benchmark on each batch of "nbLoops" runs.

Returns:

the computation times

toString

public String toString()

Returns a string representation of the benchmark evaluation statistical results.

Overrides:

toString in class Object

Returns:

a string representation of the benchmark evaluation statistical results

loopsPerSecondEstimator

public static double loopsPerSecondEstimator(Runnable benchmarkFunction)

Estimates very approximately the number of loops per seconds that can be done by the provided function.

The estimation takes around 0.2 seconds (unless 1 run takes more than 0.2).

Parameters:

benchmarkFunction - The function to benchmark

Returns:

the number of loops per second that can be done. Returns 1 if a loop takes more than 1 second.