Package esys :: Package escript :: Module benchmark :: Class BenchmarkFilter

Class BenchmarkFilter

object --+
         |
        BenchmarkFilter

Object to filter the characteristics returned by Benchmark runs.

Instance Methods

[hide private]

list of str

__call__(self, result)
Filters out results returned as characteristics of a problem run.

__init__(self)
Sets up a filter.

list of str

getResultNames(self)
Returns the names of the results produced when run() is called.

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

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

call(self, result)
(Call operator)

Filters out results returned as characteristics of a problem run.

Parameters:

result (any type that is produced by the BenchmarkProblem it is applied to) - values to be filtered

Returns: list of str

a list of strings selected from result

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

init(self)
(Constructor)

Sets up a filter.

Overrides: object.__init__

getResultNames(self)

Returns the names of the results produced when run() is called.

Returns: list of str: the list of the names to be used when the results of the run() call are printed

Note: this function has to overwritten by a particular problem

Class BenchmarkFilter

__call__(self, result) (Call operator)

__init__(self) (Constructor)

getResultNames(self)

call(self, result)
(Call operator)

init(self)
(Constructor)