aboutsummaryrefslogtreecommitdiff
path: root/pyecsca/ec/op.py
diff options
context:
space:
mode:
Diffstat (limited to 'pyecsca/ec/op.py')
-rw-r--r--pyecsca/ec/op.py9
1 files changed, 8 insertions, 1 deletions
diff --git a/pyecsca/ec/op.py b/pyecsca/ec/op.py
index d72716d..ee23e51 100644
--- a/pyecsca/ec/op.py
+++ b/pyecsca/ec/op.py
@@ -6,12 +6,12 @@ from typing import FrozenSet, cast, Any, Optional, Union
from public import public
-from .context import ResultAction
from .mod import Mod
@public
class OpType(Enum):
+ """A type of binary and unary operators."""
Add = (2, "+")
Sub = (2, "-")
Neg = (1, "-")
@@ -29,12 +29,19 @@ class OpType(Enum):
@public
class CodeOp(object):
+ """An operation that can be executed."""
result: str
+ """The result variable of the operation (e.g. the `r` in `r = 2*a`)."""
parameters: FrozenSet[str]
+ """The parameters used in the operation (e.g. `a`, `b`)."""
variables: FrozenSet[str]
+ """The variables used in the operation (e.g. `X1`, `Z2`)."""
code: Module
+ """The code of the operation."""
operator: OpType
+ """The operator type that executes in the operation."""
compiled: CodeType
+ """The compiled code of the operation."""
def __init__(self, code: Module):
self.code = code