Skip to content

dual_constant_distribution

DualConstantDistribution

Bases: BaseDistribution

This class represents a dual constant distribution, a type of statistical distribution where the outcomes are distributed between a constant value and zero based on a proportion. A dual constant distribution is defined by two parameters: the proportion and the constant value.

This distribution is not supported in EMOD demographics.

Parameters:

Name Type Description Default
proportion float
  • The proportion of value of zero.
  • This value should be between 0 and 1.
 required
constant float
  • The second constant value that this distribution returns other than zero.
  • The value should not be negative.
 required

Raises:

Type Description
ValueError

If 'proportion' argument is not between 0 and 1 or 'constant' argument is negative.
Example

Create a DualConstantDistribution object.

In the follow example, there will be 20% of zeros and 80% of 5s.

dcd = DualConstantDistribution(0.2, 5)

The proportion and constant attributes can be accessed and updated.

dcd.proportion 0.2 dcd.constant 5 dcd.proportion = 0.6 dcd.proportion 0.6

Source code in emod_api/utils/distributions/dual_constant_distribution.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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
class DualConstantDistribution(BaseDistribution):
    """
    This class represents a dual constant distribution, a type of statistical distribution where the outcomes are
    distributed between a constant value and zero based on a proportion. A dual constant
    distribution is defined by two parameters: the proportion and the constant value.

    This distribution is not supported in EMOD demographics.

    Args:
        proportion (float):
            - The proportion of value of zero.
            - This value should be between 0 and 1.

        constant (float):
            - The second constant value that this distribution returns other than zero.
            - The value should not be negative.

    Raises:
        ValueError: If 'proportion' argument is not between 0 and 1 or 'constant' argument is negative.

    Example:
        >>> # Create a DualConstantDistribution object.
        >>> # In the follow example, there will be 20% of zeros and 80% of 5s.
        >>> dcd = DualConstantDistribution(0.2, 5)
        >>> # The proportion and constant attributes can be accessed and updated.
        >>> dcd.proportion
        0.2
        >>> dcd.constant
        5
        >>> dcd.proportion = 0.6
        >>> dcd.proportion
        0.6
    """
    def __init__(self, proportion: float, constant: float):
        if proportion < 0 or proportion > 1:
            raise ValueError("The 'proportion' argument should be between 0 and 1.")
        if constant < 0:
            raise ValueError("The 'constant' argument should not be negative.")
        super().__init__()
        self.proportion = proportion
        self.constant = constant

    def set_intervention_distribution(self, intervention_object: s2c.ReadOnlyDict, prefix: str):
        """
        Set the distribution parameters to the object.

        Args:
            intervention_object (s2c.ReadOnlyDict):
                - The object to set.
            prefix (str):
                - The prefix of the parameters.
        """
        self._set_parameters(intervention_object, f"{prefix}_Distribution",
                             DistributionType.DUAL_CONSTANT_DISTRIBUTION.value)
        self._set_parameters(intervention_object, f"{prefix}_Proportion_0", self.proportion)
        self._set_parameters(intervention_object, f"{prefix}_Peak_2_Value", self.constant)

    def get_demographic_distribution_parameters(self) -> dict:
        """
        This function is not supported in the demographic object. Raise NotImplementedError if called.
        """
        raise NotImplementedError("DualConstantDistribution does not support demographic distribution. Please use "
                                  "other distributions.")

get_demographic_distribution_parameters()

This function is not supported in the demographic object. Raise NotImplementedError if called.

Source code in emod_api/utils/distributions/dual_constant_distribution.py 
63
64
65
66
67
68
def get_demographic_distribution_parameters(self) -> dict:
    """
    This function is not supported in the demographic object. Raise NotImplementedError if called.
    """
    raise NotImplementedError("DualConstantDistribution does not support demographic distribution. Please use "
                              "other distributions.")

set_intervention_distribution(intervention_object, prefix)

Set the distribution parameters to the object.

Parameters:

Name Type Description Default
intervention_object ReadOnlyDict
  • The object to set.
 required
prefix str
  • The prefix of the parameters.
 required
Source code in emod_api/utils/distributions/dual_constant_distribution.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
61
def set_intervention_distribution(self, intervention_object: s2c.ReadOnlyDict, prefix: str):
    """
    Set the distribution parameters to the object.

    Args:
        intervention_object (s2c.ReadOnlyDict):
            - The object to set.
        prefix (str):
            - The prefix of the parameters.
    """
    self._set_parameters(intervention_object, f"{prefix}_Distribution",
                         DistributionType.DUAL_CONSTANT_DISTRIBUTION.value)
    self._set_parameters(intervention_object, f"{prefix}_Proportion_0", self.proportion)
    self._set_parameters(intervention_object, f"{prefix}_Peak_2_Value", self.constant)