org.perfidix

Class Benchmark

java.lang.Object

org.perfidix.Benchmark

public final class Benchmark
extends Object

Class to hold all classes which want to be benchmarked.

 
 
 public class MyBenchmark {
 
     public static void main(final String[] args) {
         // Build up own config
         final AbstractConfig config = new MyConfig();
 
         // Initialise benchmark with config
         final Benchmark benchmark = new Benchmark(config);
 
         // Adding Classes to benchmark
         benchmark.add(Class1.class);
         benchmark.add(Class2.class);
         benchmark.add(Object3); // of Class3, every class is allowed to be inserted only once
 
         // Running benchmark
         final BenchmarkResult result = benchmark.run();
 
         // Printing out Result in a Tabular, every AbstractOutput implementing class is allowed.
         new TabularSummaryOutput().visitBenchmark(result);
 
     }
 }
 
 

Author:

Sebastian Graf, University of Konstanz

See Also:

AbstractConfig, BenchmarkResult

Constructor Summary

Constructors

Constructor and Description
Benchmark() Convience constructor using the AbstractConfig.StandardConfig
Benchmark(AbstractConfig paramConf) Constructor with a fixed set of used meters.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Class<?> clazz) Adding a class to bench to this benchmark.
void	add(Object obj) Adding a already instantiated objects to benchmark.
List<BenchmarkElement>	getBenchmarkElements() Getting all benchmarkable objects out of the registered classes with the annotated number of runs.
List<BenchmarkMethod>	getBenchmarkMethods() Getting all Benchmarkable methods out of the registered class.
Map<BenchmarkMethod,Integer>	getNumberOfMethodsAndRuns() Getting the number of all methods and all runs
BenchmarkResult	run() Running this benchmark

Methods inherited from class java.lang.Object

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

Constructor Detail

Benchmark

public Benchmark(AbstractConfig paramConf)

Constructor with a fixed set of used meters.

Parameters:

paramConf - Configuration for Benchmark

Benchmark

public Benchmark()

Convience constructor using the AbstractConfig.StandardConfig

Method Detail

add

public void add(Class<?> clazz)

Adding a class to bench to this benchmark. This class should contain benchmarkable methods, otherwise it will be ignored.

Parameters:

clazz - to be added.

add

public void add(Object obj)

Adding a already instantiated objects to benchmark. Per benchmark, only one objects of each class is allowed.

Parameters:

obj - to be added

getNumberOfMethodsAndRuns

public Map<BenchmarkMethod,Integer> getNumberOfMethodsAndRuns()

Getting the number of all methods and all runs

Returns:

a map with all methods and the runs.

run

public BenchmarkResult run()

Running this benchmark

Returns:

BenchmarkResult the result in an BenchmarkResult container.

getBenchmarkMethods

public List<BenchmarkMethod> getBenchmarkMethods()

Getting all Benchmarkable methods out of the registered class.

Returns:

a Set with BenchmarkMethod

getBenchmarkElements

public List<BenchmarkElement> getBenchmarkElements()

Getting all benchmarkable objects out of the registered classes with the annotated number of runs.

Returns:

a Set with BenchmarkMethod