Removed references to the R-Matrix; Comment changes

This commit is contained in:
2022-11-10 08:37:13 +01:00
parent 3a178f2d35
commit 5865a8683f
5 changed files with 3 additions and 44 deletions

View File

@@ -10,13 +10,11 @@ class SoftDecisionDecoder:
one with the largest correlation.
"""
# TODO: Is 'R' actually called 'decoding matrix'?
def __init__(self, G: np.array, H: np.array):
"""Construct a new SoftDecisionDecoder object.
:param G: Generator matrix
:param H: Parity check matrix
:param R: Decoding matrix
"""
self._G = G
self._H = H

View File

@@ -7,13 +7,11 @@ class ProximalDecoder:
by Tadashi Wadayama, and Satoshi Takabe.
"""
# TODO: Is 'R' actually called 'decoding matrix'?
def __init__(self, H: np.array, K: int = 100, step_size: float = 0.1,
gamma: float = 0.05, eta: float = 1.5):
"""Construct a new ProximalDecoder Object.
:param H: Parity Check Matrix
:param R: Decoding matrix
:param K: Max number of iterations to perform when decoding
:param step_size: Step size for the gradient descent process
:param gamma: Positive constant. Arises in the approximation of the prior PDF
@@ -54,7 +52,7 @@ class ProximalDecoder:
"""Project a vector onto [-eta, eta]^n in order to avoid numerical instability.
Detailed in 3.2, p. 3 (Equation (15)).
:param x:
:param x: Vector to project
:return: x clipped to [-eta, eta]^n
"""
return np.clip(x, -self._eta, self._eta)