precedence.RndBiasedBooleanValue Class Reference

Inheritance diagram for precedence.RndBiasedBooleanValue:

Collaboration diagram for precedence.RndBiasedBooleanValue:

Public Member Functions
def	__init__ (self, pattern, seed=None)
def	get (self)
def	get_pattern (self)

Public Attributes
	pattern
	generator

Private Member Functions
def	_create_generator (self, pattern)

Detailed Description

Provides randomly ordered set of boolean values with requested proportion of True and False.

Definition at line 121 of file precedence.py.

Constructor & Destructor Documentation

__init__()

def precedence.RndBiasedBooleanValue.__init__	(		self,
			pattern,
			seed = None
	)

Keyword arguments:
pattern -- either a dictionary describing proportion of True and False (e.g., {True:5,False:15}), or
   a list/tuple containing a pattern to be used as-is (e.g., [False,True,True,False])
seed -- an int, long or other hashable object to initialize random number generator (passed to random.shuffle as-is)

Definition at line 124 of file precedence.py.

    def __init__(self, pattern, seed=None):
        """
        Keyword arguments:
        pattern -- either a dictionary describing proportion of True and False (e.g., {True:5,False:15}), or
                   a list/tuple containing a pattern to be used as-is (e.g., [False,True,True,False])
        seed -- an int, long or other hashable object to initialize random number generator (passed to random.shuffle as-is)
        """
 
        if isinstance(pattern, dict):
            proportion = pattern
 
            length = proportion[True] + proportion[False]
            if length <= 0:
                raise "ERROR: Wrong set length requested: %i " % length
 
            self.pattern = [False for i in range(proportion[False])] + [
                True for i in range(proportion[True])
            ]
 
            if seed is not None:
                random.seed(seed)
 
            random.shuffle(self.pattern)
 
        elif isinstance(pattern, (list, tuple)):
            self.pattern = pattern
        else:
            raise "ERROR: unknown pattern type"
 
        self.generator = self._create_generator(self.pattern)
 

Member Function Documentation

_create_generator()

def precedence.RndBiasedBooleanValue._create_generator (   self,   pattern  )

private

Definition at line 155 of file precedence.py.

    def _create_generator(self, pattern):
        for b in pattern:
            yield b
 

get()

def precedence.RndBiasedBooleanValue.get

(

self

)

Definition at line 159 of file precedence.py.

    def get(self):
        return next(self.generator)
 

get_pattern()

def precedence.RndBiasedBooleanValue.get_pattern

(

self

)

Definition at line 162 of file precedence.py.

    def get_pattern(self):
        return self.pattern
 
 

Member Data Documentation

generator

precedence.RndBiasedBooleanValue.generator

Definition at line 153 of file precedence.py.

pattern

precedence.RndBiasedBooleanValue.pattern

Definition at line 139 of file precedence.py.

---

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

• GaudiHive/python/GaudiHive/precedence.py