diff options
Diffstat (limited to 'pyecsca/sca/trace/combine.py')
| -rw-r--r-- | pyecsca/sca/trace/combine.py | 18 |
1 files changed, 8 insertions, 10 deletions
diff --git a/pyecsca/sca/trace/combine.py b/pyecsca/sca/trace/combine.py index 853b127..9df6059 100644 --- a/pyecsca/sca/trace/combine.py +++ b/pyecsca/sca/trace/combine.py @@ -1,6 +1,4 @@ -""" -This module provides functions for combining traces sample-wise. -""" +"""This module provides functions for combining traces sample-wise.""" from typing import Callable, Optional, Tuple import numpy as np @@ -12,7 +10,7 @@ from .trace import Trace, CombinedTrace @public def average(*traces: Trace) -> Optional[CombinedTrace]: """ - Average `traces`, sample-wise. + Average :paramref:`~.average.traces`, sample-wise. :param traces: :return: @@ -35,7 +33,7 @@ def conditional_average( *traces: Trace, condition: Callable[[Trace], bool] ) -> Optional[CombinedTrace]: """ - Average `traces` for which the `condition` is True, sample-wise. + Average :paramref:`~.conditional_average.traces` for which the :paramref:`~.conditional_average.condition` is ``True``, sample-wise. :param traces: :param condition: @@ -47,7 +45,7 @@ def conditional_average( @public def standard_deviation(*traces: Trace) -> Optional[CombinedTrace]: """ - Compute the sample standard-deviation of the `traces`, sample-wise. + Compute the sample standard-deviation of the :paramref:`~.standard_deviation.traces`, sample-wise. :param traces: :return: @@ -74,7 +72,7 @@ def standard_deviation(*traces: Trace) -> Optional[CombinedTrace]: @public def variance(*traces: Trace) -> Optional[CombinedTrace]: """ - Compute the sample variance of the `traces`, sample-wise. + Compute the sample variance of the :paramref:`~.variance.traces`, sample-wise. :param traces: :return: @@ -101,7 +99,7 @@ def variance(*traces: Trace) -> Optional[CombinedTrace]: @public def average_and_variance(*traces) -> Optional[Tuple[CombinedTrace, CombinedTrace]]: """ - Compute the average and sample variance of the `traces`, sample-wise. + Compute the average and sample variance of the :paramref:`~.average_and_variance.traces`, sample-wise. :param traces: :return: @@ -130,7 +128,7 @@ def average_and_variance(*traces) -> Optional[Tuple[CombinedTrace, CombinedTrace @public def add(*traces: Trace) -> Optional[CombinedTrace]: """ - Add `traces`, sample-wise. + Add :paramref:`~.add.traces`, sample-wise. :param traces: :return: @@ -149,7 +147,7 @@ def add(*traces: Trace) -> Optional[CombinedTrace]: @public def subtract(one: Trace, other: Trace) -> CombinedTrace: """ - Subtract `other` from `one`, sample-wise. + Subtract :paramref:`~.subtract.other` from :paramref:`~.subtract.one`, sample-wise. :param one: :param other: |