Package esys :: Package escript :: Module benchmark :: Class BenchmarkProblem

Class BenchmarkProblem

object --+
         |
        BenchmarkProblem

Represents a benchmark problem that can be run and which returns a list of characteristics such as timing, MFlops, error, etc.

Instance Methods

__init__(self, name=None)
Sets up a benchmark problem.

str

__str__(self)
Returns the name of the benchmark suite.

any type that can be read by the BenchmarkFilter applied to it

run(self, options=None)
Runs the problem and returns a list of run characteristics.

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__

Properties

Inherited from object: __class__

Method Details

Sets up a benchmark problem.

Parameters:

name (str) - name of the problem. If no name is given the class name is used.

Overrides: object.__init__

Returns the name of the benchmark suite.

Runs the problem and returns a list of run characteristics.

Parameters:

options (Options) - the options that are used for the run. Note that the number of OpenMP threads is controlled by the Benchmark the problem is run in.

Returns: any type that can be read by the BenchmarkFilter applied to it

run characteristics

Note: this function has to be overwritten by a particular problem