ReedSolomonDecoder
in package
Implements Reed-Solomon decoding, as the name implies.
The algorithm will not be explained here, but the following references were helpful in creating this implementation:
- Bruce Maggs. "Decoding Reed-Solomon Codes" (see discussion of Forney's Formula)
- J.I. Hall. "Chapter 5. Generalized Reed-Solomon Codes" (see discussion of Euclidean algorithm)
Much credit is due to William Rucklidge since portions of this code are an indirect port of his C++ Reed-Solomon implementation.
Tags
Table of Contents
- decode() : array<string|int, int>
- Decodes given set of received codewords, which include both data and error-correction codewords. Really, this means it uses Reed-Solomon to detect and correct errors, in-place, in the input.
- findErrorLocations() : array<string|int, mixed>
- findErrorMagnitudes() : array<string|int, mixed>
- runEuclideanAlgorithm() : array<string|int, GenericGFPoly>
Methods
decode()
Decodes given set of received codewords, which include both data and error-correction codewords. Really, this means it uses Reed-Solomon to detect and correct errors, in-place, in the input.
public
decode(array<string|int, mixed> $received, int $numEccCodewords) : array<string|int, int>
Parameters
- $received : array<string|int, mixed>
-
data and error-correction codewords
- $numEccCodewords : int
-
number of error-correction codewords available
Tags
Return values
array<string|int, int> —findErrorLocations()
private
findErrorLocations(GenericGFPoly $errorLocator) : array<string|int, mixed>
Parameters
- $errorLocator : GenericGFPoly
Tags
Return values
array<string|int, mixed> —findErrorMagnitudes()
private
findErrorMagnitudes(GenericGFPoly $errorEvaluator, array<string|int, mixed> $errorLocations) : array<string|int, mixed>
Parameters
- $errorEvaluator : GenericGFPoly
- $errorLocations : array<string|int, mixed>
Return values
array<string|int, mixed> —runEuclideanAlgorithm()
private
runEuclideanAlgorithm(GenericGFPoly $a, GenericGFPoly $b, int $R) : array<string|int, GenericGFPoly>
Parameters
- $a : GenericGFPoly
- $b : GenericGFPoly
- $R : int
Tags
Return values
array<string|int, GenericGFPoly> —[sigma, omega]