GaudiHive.precedence.RealTimeValue Class Reference

Inheritance diagram for GaudiHive.precedence.RealTimeValue:

Collaboration diagram for GaudiHive.precedence.RealTimeValue:

Public Member Functions
def	__init__ (self, path, defaultTime, factor=1)
def	get (self, algoName="")

Public Attributes
	path
	factor
	defaultTime
	varRuntime
	file
	timings

Detailed Description

A class to manage real algorithm timing

Definition at line 73 of file precedence.py.

Constructor & Destructor Documentation

__init__()

def GaudiHive.precedence.RealTimeValue.__init__	(		self,
			path,
			defaultTime,
			factor = 1
	)

defaultTime -- run time, assigned to an algorithm if no time is found in provided timing library
       (and it will also be scaled by the 'factor' argument)

Definition at line 76 of file precedence.py.

    def __init__(self, path, defaultTime, factor=1):
        """
        defaultTime -- run time, assigned to an algorithm if no time is found in provided timing library
                       (and it will also be scaled by the 'factor' argument)
        """
 
        self.path = os.path.realpath(_buildFilePath(path))
        self.factor = factor
        self.defaultTime = defaultTime  # typically 0.05s
        self.varRuntime = 0
 
        self.file = open(self.path)
        self.timings = json.load(self.file)
 

Member Function Documentation

get()

def GaudiHive.precedence.RealTimeValue.get	(		self,
			algoName = ""
	)

Get time for a given algorithm name

Definition at line 90 of file precedence.py.

    def get(self, algoName=""):
        """Get time for a given algorithm name"""
 
        if algoName in self.timings:
            time = float(self.timings[algoName])
        else:
            capAlgoName = algoName[0].upper() + algoName[1 : len(algoName)]
 
            if capAlgoName in self.timings:
                time = float(self.timings[capAlgoName])
            else:
                time = self.defaultTime
                print(
                    "WARNING: Timing for %s (or %s) not found in the provided library, using default one: %s"
                    % (algoName, capAlgoName, time)
                )
 
        time = time * self.factor
 
        return time, self.varRuntime
 
 

Member Data Documentation

defaultTime

GaudiHive.precedence.RealTimeValue.defaultTime

Definition at line 84 of file precedence.py.

factor

GaudiHive.precedence.RealTimeValue.factor

Definition at line 83 of file precedence.py.

file

GaudiHive.precedence.RealTimeValue.file

Definition at line 87 of file precedence.py.

path

GaudiHive.precedence.RealTimeValue.path

Definition at line 82 of file precedence.py.

timings

GaudiHive.precedence.RealTimeValue.timings

Definition at line 88 of file precedence.py.

varRuntime

GaudiHive.precedence.RealTimeValue.varRuntime

Definition at line 85 of file precedence.py.

---

The documentation for this class was generated from the following file:

• GaudiHive/python/GaudiHive/precedence.py