/*
|
* Copyright 2012 ZXing authors
|
*
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
* you may not use this file except in compliance with the License.
|
* You may obtain a copy of the License at
|
*
|
* http://www.apache.org/licenses/LICENSE-2.0
|
*
|
* Unless required by applicable law or agreed to in writing, software
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
* See the License for the specific language governing permissions and
|
* limitations under the License.
|
*/
|
|
@class ZXGenericGF, ZXIntArray;
|
|
/**
|
* 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.
|
* http://www.cs.cmu.edu/afs/cs.cmu.edu/project/pscico-guyb/realworld/www/rs_decode.ps
|
* "Decoding Reed-Solomon Codes" (see discussion of Forney's Formula)
|
*
|
* J.I. Hall. www.mth.msu.edu/~jhall/classes/codenotes/GRS.pdf
|
* "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.
|
*/
|
@interface ZXReedSolomonDecoder : NSObject
|
|
- (id)initWithField:(ZXGenericGF *)field;
|
|
/**
|
* 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.
|
*
|
* @param received data and error-correction codewords
|
* @param twoS number of error-correction codewords available
|
* @return NO if decoding fails for any reason
|
*/
|
- (BOOL)decode:(ZXIntArray *)received twoS:(int)twoS error:(NSError **)error;
|
|
@end
|
