Skip to content

Operation

symconstraints.operation

Operations module.

Operation dataclass

Generic operation.

Attributes:

Name Type Description
keys frozenset[Symbol]

Set of keys that this operation needs to check if its not missing before executing.
inferred_by frozenset[Boolean]

Set of constraints which generated this operation.
Source code in src/symconstraints/operation.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
@dataclass(eq=True, frozen=True)
class Operation:
    """Generic operation.

    Attributes
    ----------
    keys : frozenset[Symbol]
        Set of keys that this operation needs to check if its not missing before executing.
    inferred_by : frozenset[Boolean]
        Set of constraints which generated this operation.
    """

    keys: frozenset[Symbol]
    inferred_by: frozenset[Boolean] = field(kw_only=True, default_factory=frozenset)

Validation dataclass

Bases: Operation

Validation operation.

Attributes:

Name Type Description
operations frozenset[Boolean]

A set of SymPy Boolean expressions that are used to validate the keys.
Source code in src/symconstraints/operation.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
@dataclass(eq=True, frozen=True)
class Validation(Operation):
    """Validation operation.

    Attributes
    ----------
    operations : frozenset[Boolean]
        A set of SymPy Boolean expressions that are used to validate the keys.
    """

    operations: frozenset[Boolean]

    def __str__(self):
        return (
            f'Validation: ({", ".join(str(k) for k in self.keys)}) => [{", ".join(str(op) for op in self.operations)}]'
            f' inferred by ({", ".join(str(op) for op in self.inferred_by)})'
        )

    def __repr__(self):
        return str(self)

Imputation dataclass

Bases: Operation

Imputation operation.

Attributes:

Name Type Description
target_key Symbol

Key that will be imputed by this operation
operation Expr

SymPy expression used to impute the target key
Source code in src/symconstraints/operation.py 
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
@dataclass(eq=True, frozen=True)
class Imputation(Operation):
    """Imputation operation.

    Attributes
    ----------
    target_key : Symbol
        Key that will be imputed by this operation

    operation : Expr
        SymPy expression used to impute the target key
    """

    target_key: Symbol
    operation: Expr

    def __str__(self):
        return (
            f'Imputation: ({", ".join(str(k) for k in self.keys)}) => {str(self.target_key)} = {self.operation}'
            f' inferred by ({", ".join(str(op) for op in self.inferred_by)})'
        )

    def __repr__(self):
        return str(self)