esys.escript.benchmark.BenchmarkSuite

Package esys :: Package escript :: Module benchmark :: Class BenchmarkSuite

[show private | hide private]

Type BenchmarkSuite

object --+
         |
        BenchmarkSuite

framework to run a bunch of Benchmarks with the object to create a table of statistics.

Method Summary
	`__init__(self, name)` sets up a suite of benchmarks
`Benchmark`	`__getitem__(self, i)` returns the i-th benchmark in the suite through self[i]
`int`	`__len__(self)` returns the number of benchmarks in the suite
`str`	`__str__(self)` returns the name of the benchmark suite
	`addBenchmark(self, benchmark)` adds a `Benchmark` to the suite
`str`	`getHTML(self, filter, level)` returns the results of the last benchmark run in HTML format.
	`run(self, scale)` runs all benchmarks
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__repr__(x)` x.__repr__() <==> repr(x)
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value

Class Variable Summary
`int`	`MAX_LEVEL` = 5

Method Details

init(self, name=None)
(Constructor)

sets up a suite of benchmarks

Parameters:: name - name of the benchmark suite. If no name is given the class name is used.
(type=str)

Overrides:: __builtin__.object.__init__

getitem(self, i)
(Indexing operator)

returns the i-th benchmark in the suite through self[i]

Parameters:: i - index of the requested benchmark
(type=int)

Returns:: i-th benchmark
(type=Benchmark)

len(self)
(Length operator)

returns the number of benchmarks in the suite

Returns:: number of benchmarks
(type=int)

str(self)
(Informal representation operator)

returns the name of the benchmark suite

Returns:: name
(type=str)

Overrides:: __builtin__.object.__str__

addBenchmark(self, benchmark)

adds a Benchmark to the suite

Parameters:: benchmark - adds a new Benchmark to the suite
(type=Benchmark)

getHTML(self, filter, level=1)

returns the results of the last benchmark run in HTML format.

Parameters:: filter - filter to be applied to the results
(type=BenchmarkFilter); level - level used in header <H?> tags
(type=int)

Returns:: HTML document
(type=str)

run(self, scale=1)

runs all benchmarks

Parameters:: scale - defines the number of (OpenMP) threads to be used. If scale is a scalar all benchmarks are run with scale number of threads. If scale is a list, the p-th problem in each of the benchmarks in the suite is run with scale[p] threads. If scale[p]<1 teh p-th problem is omitted.
(type=int or list of ints.)

Class Variable Details

MAX_LEVEL

Type:: int
Value:: 5

Generated by Epydoc 2.1 on Thu Apr 27 11:16:12 2006

http://epydoc.sf.net

Type BenchmarkSuite

__init__(self, name=None) (Constructor)

__getitem__(self, i) (Indexing operator)

__len__(self) (Length operator)

__str__(self) (Informal representation operator)