precedence.RealTimeValue Class Reference

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

Public Attributes
	path = os.path.realpath(_buildFilePath(path))
	factor = factor
	defaultTime = defaultTime
int	varRuntime = 0
	file = open(self.path)
	timings = json.load(self.file)

Detailed Description

A class to manage real algorithm timing

Definition at line 74 of file precedence.py.

Constructor & Destructor Documentation

__init__()

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 77 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()

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

Get time for a given algorithm name

Definition at line 91 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(
                    f"WARNING: Timing for {algoName} (or {capAlgoName}) not found in the provided library, using default one: {time}"
                )
 
        time = time * self.factor
 
        return time, self.varRuntime
 
 

Member Data Documentation

defaultTime

precedence.RealTimeValue.defaultTime = defaultTime

Definition at line 85 of file precedence.py.

factor

precedence.RealTimeValue.factor = factor

Definition at line 84 of file precedence.py.

file

precedence.RealTimeValue.file = open(self.path)

Definition at line 88 of file precedence.py.

path

precedence.RealTimeValue.path = os.path.realpath(_buildFilePath(path))

Definition at line 83 of file precedence.py.

timings

precedence.RealTimeValue.timings = json.load(self.file)

Definition at line 89 of file precedence.py.

varRuntime

int precedence.RealTimeValue.varRuntime = 0

Definition at line 86 of file precedence.py.

---

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

• GaudiHive/python/GaudiHive/precedence.py