/[escript]/trunk/escript/py_src/benchmark.py
ViewVC logotype

Diff of /trunk/escript/py_src/benchmark.py

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 719 by gross, Thu Mar 23 10:55:31 2006 UTC revision 720 by gross, Thu Apr 27 10:16:05 2006 UTC
# Line 27  from esys.escript import setNumberOfThre Line 27  from esys.escript import setNumberOfThre
27  class BenchmarkSuite(object):  class BenchmarkSuite(object):
28     """     """
29     framework to run a bunch of L{Benchmark}s with the object to create a table of statistics.     framework to run a bunch of L{Benchmark}s with the object to create a table of statistics.
30     @var MAX_LEVEL: maximum number of level in headers for output  
31       @cvar MAX_LEVEL: maximum number of level in headers for output
32     """     """
33     MAX_LEVEL=5     MAX_LEVEL=5
34     def __init__(self,name=None):     def __init__(self,name=None):
# Line 173  class Benchmark(object): Line 174  class Benchmark(object):
174         adds a options to the benchmark         adds a options to the benchmark
175    
176         @param options: adds a new option to the bechmark. If options==None they are are ignored         @param options: adds a new option to the bechmark. If options==None they are are ignored
177         @type problem: L{Options}         @type options: L{Options}
178         """         """
179         if options!=None: self.__options.append(options)         if options!=None: self.__options.append(options)
180    
# Line 314  class BenchmarkProblem(object): Line 315  class BenchmarkProblem(object):
315         @type options: L{Options}         @type options: L{Options}
316         @return: run characteristics         @return: run characteristics
317         @rtype: any type that can be read by the L{BenchmarkFilter} applied to it.         @rtype: any type that can be read by the L{BenchmarkFilter} applied to it.
318         @remark: this function has to overwritten by a particular problem         @note: this function has to overwritten by a particular problem
319         """         """
320         raise NotImplementedError         raise NotImplementedError
321         return []         return []
# Line 337  class BenchmarkFilter(object): Line 338  class BenchmarkFilter(object):
338                
339         @return: names the list of the names to be used when the results of the run() call are printed         @return: names the list of the names to be used when the results of the run() call are printed
340         @rtype: C{list} of C{str}         @rtype: C{list} of C{str}
341         @remark: this function has to overwritten by a particular problem         @note: this function has to overwritten by a particular problem
342         """         """
343         raise NotImplementedError         raise NotImplementedError
344         return []         return []
# Line 350  class BenchmarkFilter(object): Line 351  class BenchmarkFilter(object):
351         @type result: any type that is produced by the L{BenchmarkProblem} it is applied to         @type result: any type that is produced by the L{BenchmarkProblem} it is applied to
352         @return: a list of strings selected from result         @return: a list of strings selected from result
353         @rtype: C{list} of C{str}         @rtype: C{list} of C{str}
354         @remark: this function has to overwritten by a particular problem         @note: this function has to overwritten by a particular problem
355         """         """
356         raise NotImplementedError         raise NotImplementedError
357         return []         return []

Legend:
Removed from v.719  
changed lines
  Added in v.720

  ViewVC Help
Powered by ViewVC 1.1.26