[MN-dev] [mndiff]: r206 - trunk/noe/rs.h

[michael]

Author: michael
Date: Mon Jul 19 16:20:20 2010
New Revision: 206

Log:
Clarify that one can use a parityCount during decoding that is smaller than what was used during encoding.

Modified:
   trunk/noe/rs.h

Modified: trunk/noe/rs.h
==============================================================================
--- trunk/noe/rs.h	Mon Jul 19 16:20:19 2010	(r205)
+++ trunk/noe/rs.h	Mon Jul 19 16:20:20 2010	(r206)
@@ -50,7 +50,10 @@ void noe_rsEncode_10001(GFF4Element *dat
 /**
  * Corrects some data using a Reed Solomon code.
  * @param data The input codeword to correct and the corrected output codeword.
- * @param parityCount The number of parity symbols
+ * @param parityCount The number of parity symbols.
+ *        You can pass a smaller value here than what was used during noe_rsEncode*()
+ *        Using a smaller value here is faster but decoding is only guranteed to succeed
+ *        as long as parityCount >= erasedCount + 2*errorCount
  * @param erasedCount The number of erased symbols, that is symbols for which we know they
  *        are damaged / damaged symbols with known locations.
  * @param erased the indexes in the input codeword of erased symbols.