aboutsummaryrefslogtreecommitdiff
path: root/pyecsca/ec/mult.py
diff options
context:
space:
mode:
authorJ08nY2021-01-20 20:24:11 +0100
committerJ08nY2021-01-20 20:24:11 +0100
commit9ec68bdb56882777e5b3670380bf1e1ad7d0a7a3 (patch)
treebb695e485808e4d0517d84053019e2f7ddb03679 /pyecsca/ec/mult.py
parentadc3cd52147f35e0a7cc9008ac96619dd89cda48 (diff)
downloadpyecsca-9ec68bdb56882777e5b3670380bf1e1ad7d0a7a3.tar.gz
pyecsca-9ec68bdb56882777e5b3670380bf1e1ad7d0a7a3.tar.zst
pyecsca-9ec68bdb56882777e5b3670380bf1e1ad7d0a7a3.zip
Diffstat (limited to 'pyecsca/ec/mult.py')
-rw-r--r--pyecsca/ec/mult.py7
1 files changed, 6 insertions, 1 deletions
diff --git a/pyecsca/ec/mult.py b/pyecsca/ec/mult.py
index 1650736..6fd6feb 100644
--- a/pyecsca/ec/mult.py
+++ b/pyecsca/ec/mult.py
@@ -1,3 +1,6 @@
+"""
+This module provides several classes implementing different scalar multiplication algorithms.
+"""
from abc import ABC, abstractmethod
from copy import copy
from typing import Mapping, Tuple, Optional, MutableMapping, ClassVar, Set, Type
@@ -29,7 +32,7 @@ class ScalarMultiplicationAction(ResultAction):
@public
class PrecomputationAction(Action):
- """"""
+ """A precomputation of a point in scalar multiplication."""
params: DomainParameters
point: Point
@@ -53,7 +56,9 @@ class ScalarMultiplier(ABC):
optionals: ClassVar[Set[Type]] # Type[Formula] but mypy has a false positive
"""The optional set of formulas that the multiplier can use."""
short_circuit: bool
+ """Whether the formulas will short-circuit upon input of the point at infinity."""
formulas: Mapping[str, Formula]
+ """All formulas the multiplier was initialized with."""
_params: DomainParameters
_point: Point
_initialized: bool = False