Skip to content

algebra

This module defines the commutative algebra structure of probability distributions.

We define an Algebra class for enforcing the requisite structure via abstract-method definitions for left-operators. Right-operators for each left-operator is added on via setattr on the Algebra class (see function define_right_operators_for_Algebra_class).

Algebra

An abstract class for enforcing the definition of operations we care about.

We specify left-operators as abstract methods in this class. Once the class is defined, we define the right-operators as being the swapped versions of their left-operators (see Algebra_reverse_op for details on how this is achieved).

Note

This class is for internal use only.

Source code in distribution_algebra/algebra.py 
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
class Algebra:
    """An abstract class for enforcing the definition of operations we care about.

    We specify left-operators as abstract methods in this class. Once
    the class is defined, we define the right-operators as being the
    swapped versions of their left-operators (see `Algebra_reverse_op`
    for details on how this is achieved).

    Note:
       This class is for internal use only.
    """

    @abstractmethod
    def __add__(self, other: Any) -> Any:
        """An abstract left-addition method."""
        ...

    @abstractmethod
    def __sub__(self, other: Any) -> Any:
        """An abstract left-subtraction method."""
        ...

    @abstractmethod
    def __mul__(self, other: Any) -> Any:
        """An abstract left-multiplication method."""
        ...

    @abstractmethod
    def __truediv__(self, other: Any) -> Any:
        """An abstract left-division method."""
        ...

    @abstractmethod
    def __pow__(self, other: Any) -> Any:
        """An abstract left-power (or left-exponentiation) method."""
        ...

    @abstractmethod
    def __neg__(self) -> Any:
        """An abstract negation (additive inverse) method."""
        ...

__add__ abstractmethod 

__add__(other: Any) -> Any

An abstract left-addition method.

Source code in distribution_algebra/algebra.py 
27
28
29
30
@abstractmethod
def __add__(self, other: Any) -> Any:
    """An abstract left-addition method."""
    ...

__mul__ abstractmethod 

__mul__(other: Any) -> Any

An abstract left-multiplication method.

Source code in distribution_algebra/algebra.py 
37
38
39
40
@abstractmethod
def __mul__(self, other: Any) -> Any:
    """An abstract left-multiplication method."""
    ...

__neg__ abstractmethod 

__neg__() -> Any

An abstract negation (additive inverse) method.

Source code in distribution_algebra/algebra.py 
52
53
54
55
@abstractmethod
def __neg__(self) -> Any:
    """An abstract negation (additive inverse) method."""
    ...

__pow__ abstractmethod 

__pow__(other: Any) -> Any

An abstract left-power (or left-exponentiation) method.

Source code in distribution_algebra/algebra.py 
47
48
49
50
@abstractmethod
def __pow__(self, other: Any) -> Any:
    """An abstract left-power (or left-exponentiation) method."""
    ...

__sub__ abstractmethod 

__sub__(other: Any) -> Any

An abstract left-subtraction method.

Source code in distribution_algebra/algebra.py 
32
33
34
35
@abstractmethod
def __sub__(self, other: Any) -> Any:
    """An abstract left-subtraction method."""
    ...

__truediv__ abstractmethod 

__truediv__(other: Any) -> Any

An abstract left-division method.

Source code in distribution_algebra/algebra.py 
42
43
44
45
@abstractmethod
def __truediv__(self, other: Any) -> Any:
    """An abstract left-division method."""
    ...

Algebra_reverse_op 

Algebra_reverse_op(op_name: str) -> Callable[[Algebra, Any], Any]

Define the right-operator method, given a left-operator name in op_name.

Note

This function is for internal use only.

Source code in distribution_algebra/algebra.py 
58
59
60
61
62
63
64
65
66
67
68
69
def Algebra_reverse_op(op_name: str) -> Callable[[Algebra, Any], Any]:
    """Define the right-operator method, given a left-operator name in `op_name`.

    Note:
       This function is for internal use only.
    """

    def self_op_other(self: Algebra, other: Any) -> Any:
        """Reverse operation is just the operation acting on the arguments."""
        return getattr(self, op_name)(other)

    return self_op_other

define_right_operators_for_Algebra_class 

define_right_operators_for_Algebra_class() -> None

Define a right-operator method for each of Algebra's magic methods.

We additionally mark each right-operator as being final in order to guard against a user over-riding them and possibly breaking symmetry with the left-operators.

Source code in distribution_algebra/algebra.py 
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
def define_right_operators_for_Algebra_class() -> None:
    """Define a right-operator method for each of `Algebra`'s magic methods.

    We additionally mark each right-operator as being `final` in order
    to guard against a user over-riding them and possibly breaking
    symmetry with the left-operators.

    """
    magic_left_operator_methods: list[str] = [
        "__add__",
        "__mul__",
        "__sub__",
        "__truediv__",
        "__pow__",
    ]

    for magic_method in magic_left_operator_methods:
        right_operator_name: str = "__r" + magic_method.removeprefix("__")
        setattr(Algebra, right_operator_name, final(Algebra_reverse_op(magic_method)))