RSDecodeInit

DEPRECATED. Initializes user-supplied memory as the IppsRSDecodeSpec_8u context for future use.

Syntax

IppStatus ippsRSDecodeInit_8u(int codeLen, int dataLen, const IppsGFSpec_8u* pGF, Ipp8u root, IppsRSDecodeSpec_8u* pRS);

Include Files

ippdi.h

Domain Dependencies

Headers: ippcore.h

Libraries: ippcore.lib

Parameters

codeLen

The desired codeword length.

dataLen

The desired data length.

pGF

Pointer to the finite field (GF) context to be used for the decoding operation.

root

The root of the (first) minimal polynomial over GF.

pRS

Pointer to the user-supplied buffer to be initialized as the IppsRSDecodeSpec_8u context.

Description

The function ippsRSDecodeInit is deprecated. This function is obsolete and will be removed in a future release. Use the following link for details: http://software.intel.com/sites/products/ipp-deprecated-features-feedback/.

The function initializes the user-supplied buffer as the RS(codeLen, dataLen) decoder context.

The buffer for the context must have size that the function ippsRSDecodeGetSize returns.

The codeLen and dataLen parameters for ippsRSDecodeInit must have the same values as in the preceding call to ippsRSDecodeGetSize. The root value defines the generating polynomial g(x) of RS(codeLen, dataLen):

g(x) = (x-root)*( x-root *a1) *( x-root *a2)*...*( x-root *a(2*t-1)),

where t is the error-correcting ability, such that 2*t = codeLen - dataLen.

Return Values

ippStsNoErr

Indicates no error. Any other value indicates an error or warning.

ippStsNullPtrErr

Indicates an error condition if any of the specified pointers is NULL.

ippStsRangeErr

Indicates an error condition if values of the parameters codeLen and/or dataLen are out of bounds determined by the inequalities: 2 ≤ codeLength < orderof(GF); 0 < dataLen < codeLen.

ippStsBadArgErr

Indicates an error condition if the value of the parameter root is not a valid element of the finite field or is equal to 0.
For more complete information about compiler optimizations, see our Optimization Notice.