Skip to content

concurrency_parameters

ConcurrencyParameters

Bases: Updateable

Source code in emodpy_hiv/demographics/concurrency_parameters.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
class ConcurrencyParameters(Updateable):
    def __init__(self,
                 probability_extra_relationship_male: float = 0,
                 probability_extra_relationship_female: float = 0,
                 max_simultaneous_relationships_male: float = 0,
                 max_simultaneous_relationships_female: float = 0):
        """
        A ConcurrencyParameters object represents the likelihood and maximum count of additional concurrent
        relationships for males and females in a simulation. One ConcurrencyParameters object typically is created
        per relationship type and risk group (e.g. one for Commercial HIGH risk relationships, one for
        Transitory MED risk relationships, etc.). See additional documentation [here](https://emod.idmod.org/emodpy-hiv/emod/parameter-demographics/#concurrency_parameters).

        Args:
            probability_extra_relationship_male (float): the probability of having extra relationships for males
            probability_extra_relationship_female (float): the probability of extra relationships for females
            max_simultaneous_relationships_male (float): the maximum simultaneous relationships for males
            max_simultaneous_relationships_female (float): the maximum simultaneous relationships for females
        """
        super().__init__()
        self.probability_extra_relationship_male = probability_extra_relationship_male
        self.probability_extra_relationship_female = probability_extra_relationship_female
        self.max_simultaneous_relationships_male = max_simultaneous_relationships_male
        self.max_simultaneous_relationships_female = max_simultaneous_relationships_female

    def to_dict(self) -> Dict:
        concurrency = {'Prob_Extra_Relationship_Male': self.probability_extra_relationship_male,
                       'Prob_Extra_Relationship_Female': self.probability_extra_relationship_female,
                       'Max_Simultaneous_Relationships_Male': self.max_simultaneous_relationships_male,
                       'Max_Simultaneous_Relationships_Female': self.max_simultaneous_relationships_female}
        return concurrency

    @classmethod
    def from_dict(cls, d: Dict) -> '__class__':
        return cls(probability_extra_relationship_male=d['Prob_Extra_Relationship_Male'],
                   probability_extra_relationship_female=d['Prob_Extra_Relationship_Female'],
                   max_simultaneous_relationships_male=d['Max_Simultaneous_Relationships_Male'],
                   max_simultaneous_relationships_female=d['Max_Simultaneous_Relationships_Female'])

__init__(probability_extra_relationship_male=0, probability_extra_relationship_female=0, max_simultaneous_relationships_male=0, max_simultaneous_relationships_female=0)

A ConcurrencyParameters object represents the likelihood and maximum count of additional concurrent relationships for males and females in a simulation. One ConcurrencyParameters object typically is created per relationship type and risk group (e.g. one for Commercial HIGH risk relationships, one for Transitory MED risk relationships, etc.). See additional documentation here.

Parameters:

Name Type Description Default
probability_extra_relationship_male float

the probability of having extra relationships for males

 0
probability_extra_relationship_female float

the probability of extra relationships for females

 0
max_simultaneous_relationships_male float

the maximum simultaneous relationships for males

 0
max_simultaneous_relationships_female float

the maximum simultaneous relationships for females

 0
Source code in emodpy_hiv/demographics/concurrency_parameters.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
def __init__(self,
             probability_extra_relationship_male: float = 0,
             probability_extra_relationship_female: float = 0,
             max_simultaneous_relationships_male: float = 0,
             max_simultaneous_relationships_female: float = 0):
    """
    A ConcurrencyParameters object represents the likelihood and maximum count of additional concurrent
    relationships for males and females in a simulation. One ConcurrencyParameters object typically is created
    per relationship type and risk group (e.g. one for Commercial HIGH risk relationships, one for
    Transitory MED risk relationships, etc.). See additional documentation [here](https://emod.idmod.org/emodpy-hiv/emod/parameter-demographics/#concurrency_parameters).

    Args:
        probability_extra_relationship_male (float): the probability of having extra relationships for males
        probability_extra_relationship_female (float): the probability of extra relationships for females
        max_simultaneous_relationships_male (float): the maximum simultaneous relationships for males
        max_simultaneous_relationships_female (float): the maximum simultaneous relationships for females
    """
    super().__init__()
    self.probability_extra_relationship_male = probability_extra_relationship_male
    self.probability_extra_relationship_female = probability_extra_relationship_female
    self.max_simultaneous_relationships_male = max_simultaneous_relationships_male
    self.max_simultaneous_relationships_female = max_simultaneous_relationships_female