Home       Trees       Index       Help   
Package esys :: Package escript :: Module benchmark :: Class Benchmark
[show private | hide private]
[frames | no frames]

Type Benchmark

object --+
         |
        Benchmark

runs a bunch of similar BenchmarkProblems with a bunch of Options
Method Summary
  __init__(self, name, description)
sets up a benchmark
str __str__(self)
returns the name of the benchmark suite
  addOptions(self, options)
adds a options to the benchmark
  addProblem(self, problem)
adds a problem to the benchmark
str getHTML(self, filter, level)
returns the results of the last benchmark run in HTML format.
  run(self, scale)
runs all problems with all options.
    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

Method Details

__init__(self, name=None, description=None)
(Constructor)

sets up a benchmark
Parameters:
name - name of the benchmark. If no name is given the class name is used.
           (type=str)
description - description of the benchmark.
           (type=str or None)
Overrides:
__builtin__.object.__init__

__str__(self)
(Informal representation operator)

returns the name of the benchmark suite
Returns:
name
           (type=str)
Overrides:
__builtin__.object.__str__

addOptions(self, options)

adds a options to the benchmark
Parameters:
options - adds a new option to the bechmark. If options==None they are are ignored

addProblem(self, problem)

adds a problem to the benchmark
Parameters:
problem - adds a new problem to the bechmark
           (type=BenchmarkProblem)

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 problems with all options.
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.)

   Home       Trees       Index       Help   
Generated by Epydoc 2.1 on Thu Apr 27 11:16:15 2006 http://epydoc.sf.net