asptDrlms32f

API Summary

• DT32S drlms32fInit (asptDrlms32f *drlms,DT32S L, DT32F mu, DT32S R)
  
• DT32S drlms32fInitStatic(asptDrlms32f *drlms,DT32S L, DT32F mu, DT32S R, DT32F *pCof, DT32F *pDat)
  
• void drlms32fFree(asptDrlms32f *drlms)
  

• DT32F drlms32fFilterUpdate (asptDrlms32f *drlms, DT32F inp, DT32F des)
  
• DT32F drlms32fLCFilterUpdate (asptDrlms32f *drlms, DT32F des)
  
• DT32F drlms32fFilterUpdateSignErr (asptDrlms32f *drlms, DT32F inp, DT32F des)
  
• DT32F drlms32fLCFilterUpdateSignErr(asptDrlms32f *drlms, DT32F des)
  
• DT32F drlms32fFilterUpdateSignReg (asptDrlms32f *drlms, DT32F inp, DT32F des)
  
• DT32F drlms32fLCFilterUpdateSignReg (asptDrlms32f *drlms, DT32F des)
  
• DT32F drlms32fFilterUpdateSignSign (asptDrlms32f *drlms, DT32F inp, DT32F des)
  
• DT32F drlms32fLCFilterUpdateSignSign(asptDrlms32f *drlms, DT32F des)
  
• DT32F drlms32fFilterOnly (asptDrlms32f *drlms, DT32F inp)
  
• DT32F drlms32fLCFilterOnly(asptDrlms32f *drlms)
  

• DT32S drlms32fGetCoef(asptDrlms32f *drlms, DT32F *buf, DT32S ind, DT32S N, DT32S flip)
  
• DT32S drlms32fGetDelayLine(asptDrlms32f *drlms, DT32F *buf, DT32S ind, DT32S N, DT32S flip)
  
• drlms32fGetCoefPtr( asptDrlms32f *drlms )
• drlms32fGetDelayLinePtr( asptDrlms32f *drlms )
• drlms32fGetFilterLength( asptDrlms32f *drlms )
• drlms32fGetDelayLineLength( asptDrlms32f *drlms )
• drlms32fGetLastErrorSample( asptDrlms32f *drlms )
• drlms32fGetStepSize( asptDrlms32f *drlms )
• drlms32fGetReuseNr( asptDrlms32f *drlms )

• DT32S drlms32fReset(asptDrlms32f *drlms)
  
• DT32S drlms32fResetDelayLine(asptDrlms32f *drlms)
  
• DT32S drlms32fResize(asptDrlms32f *drlms, DT32S newLength)
  
• DT32S drlms32fSetCoef(asptDrlms32f *drlms, DT32F *newCoef, DT32S ind, DT32S N, DT32S flip)
  
• DT32S drlms32fSetDelayLine(asptDrlms32f *drlms, DT32F *newCoef, DT32S ind, DT32S N, DT32S flip)
  
• drlms32fSetStepSize( asptDrlms32f *drlms, newStep )
• drlmsSetReuseNr( asptDrlms32f *drlms, newNr )

Description

Copyright

<< Back to top

drlms32fInit

DT32S drlms32fInit (asptDrlms32f *drlms,DT32S L, DT32F mu, DT32S R)

Initializes an asptDrlms32f filter and allocates its necessary storage buffers.
• Returns :
  • Error code. On failure, the filterLength member of the filter is set to zero.
• Input Parameters :
  • drlms : asptDrlms32f filter to be initialized
  • L : number of filter coefficients
  • mu : step size
  • R : number of data reusing cycles; R=0 is the LMS case
• Error Conditions
  • ASPT_NO_ERR : Initialization is successful
  • ASPT_RANGE_ERR : L/R is not a valid input value
  • ASPT_NO_MEM_ERR : could not allocate memory

<< Back to top

drlms32fInitStatic

DT32S drlms32fInitStatic(asptDrlms32f *drlms,DT32S L, DT32F mu, DT32S R, DT32F *pCof, DT32F *pDat)

Initializes an asptDrlms32f filter to use pre-allocated memory.
• Returns :
  • Error code. On failure, the filterLength member of the filter is set to zero.
• Input Parameters :
  • drlms : asptDrlms32f filter to be initialized
  • L : number of filter coefficients
  • mu : step size
  • R : number of data reusing cycles; R=0 is the LMS case
  • pCof : pointer to a pre-allocated memory block to be used for the adaptive filter coefficients. At least L memory locations must be available starting at this memory address.
  • pDat : pointer to a pre-allocated memory block to be used for data storage. At least L memory locations must be available starting at this memory address
• Error Conditions
  • ASPT_NO_ERR : Initialization is successful
  • ASPT_NULL_PTR_ERR : pCof/pDat is a NULL pointer
  • ASPT_RANGE_ERR : L/R is not a valid input value
  • ASPT_NO_MEM_ERR : could not allocate memory

<< Back to top

drlms32fFilterUpdate

DT32F drlms32fFilterUpdate (asptDrlms32f *drlms, DT32F inp, DT32F des)

Calculates the filter output and updates the coefficients vector according to the DRLMS algorithm.
• Returns :
  • The filter output sample.
• Input Parameters :
  • drlms : pointer to asptDrlms32f filter
  • inp : new input sample.
  • des : new desired sample
• Remarks :
  • The error sample is stored internally and can be retrieved by calling drlms32fGetLastErrorSample().

<< Back to top

drlms32fLCFilterUpdate

DT32F drlms32fLCFilterUpdate (asptDrlms32f *drlms, DT32F des)

Calculates the filter output and updates the coefficients vector according to the DRLMS algorithm for the linear combiner filter configuration. Assumes that the data delay line is externally filled with samples, therefore does not update the internal delay line.
• Returns :
  • The filter output sample.
• Input Parameters :
  • drlms : pointer to asptDrlms32f filter
  • des : new desired sample
• Remarks :
  • The error sample is stored internally and can be retrieved by calling drlms32fGetLastErrorSample().

<< Back to top

drlms32fFilterUpdateSignErr

DT32F drlms32fFilterUpdateSignErr (asptDrlms32f *drlms, DT32F inp, DT32F des)

Calculates the filter output and updates the coefficients vector according to the Sign Error DRLMS algorithm. The sign of the error sample is used in the coefficients update instead of the error value itself.
• Returns :
  • The filter output sample.
• Input Parameters :
  • drlms : pointer to asptDrlms32f filter
  • inp : new input sample.
  • des : new desired sample
• Remarks :
  • The error sample is stored internally and can be retrieved by calling drlms32fGetLastErrorSample().

<< Back to top

drlms32fLCFilterUpdateSignErr

DT32F drlms32fLCFilterUpdateSignErr(asptDrlms32f *drlms, DT32F des)

Calculates the filter output and updates the coefficients vector according to the Sign Error DRLMS algorithm for the Linear Combiner filter configuration. The sign of the error sample is used in the coefficients update instead of the error value itself. Assumes that the data delay line is externally filled with samples, therefore does not update the internal delay line.
• Returns :
  • The filter output sample.
• Input Parameters :
  • drlms : pointer to asptDrlms32f filter
  • des : new desired sample
• Remarks :
  • The error sample is stored internally and can be retrieved by calling drlms32fGetLastErrorSample().

<< Back to top

drlms32fFilterUpdateSignReg

DT32F drlms32fFilterUpdateSignReg (asptDrlms32f *drlms, DT32F inp, DT32F des)

Calculates the filter output and updates the coefficients vector according to the Sign Regressor DRLMS algorithm. The sign of the input sample is used in the coefficients update instead of the input sample value.
• Returns :
  • The filter output sample.
• Input Parameters :
  • drlms : pointer to asptDrlms32f filter
  • inp : new input sample.
  • des : new desired sample
• Remarks :
  • The error sample is stored internally and can be retrieved by calling drlms32fGetLastErrorSample().

<< Back to top

drlms32fLCFilterUpdateSignReg

DT32F drlms32fLCFilterUpdateSignReg (asptDrlms32f *drlms, DT32F des)

Calculates the filter output and updates the coefficients vector according to the Sign Regressor DRLMS algorithm for the Linear Combiner filter configuration. The sign of the input sample is used in the coefficients update instead of the input sample value. Assumes that the data delay line is externally filled with samples, therefore does not update the internal delay line.
• Returns :
  • The filter output sample.
• Input Parameters :
  • drlms : pointer to asptDrlms32f filter
  • des : new desired sample
• Remarks :
  • The error sample is stored internally and can be retrieved by calling drlms32fGetLastErrorSample().

<< Back to top

drlms32fFilterUpdateSignSign

DT32F drlms32fFilterUpdateSignSign (asptDrlms32f *drlms, DT32F inp, DT32F des)

Calculates the filter output and updates the coefficients vector according to the Sign-Sign DRLMS algorithm. The sign of the error sample as well as the sign of the input sample are used in the coefficients update instead of the error and input values.
• Returns :
  • The filter output sample.
• Input Parameters :
  • drlms : pointer to asptDrlms32f filter
  • inp : new input sample.
  • des : new desired sample
• Remarks :
  • The error sample is stored internally and can be retrieved by calling drlms32fGetLastErrorSample().

<< Back to top

drlms32fLCFilterUpdateSignSign

DT32F drlms32fLCFilterUpdateSignSign(asptDrlms32f *drlms, DT32F des)

Calculates the filter output and updates the coefficients vector according to the Sign Sign DRLMS algorithm for the Linear Combiner filter configuration. The sign of the error sample as well as the sign of the input sample are used in the coefficients update instead of the error and input values. Assumes that the data delay line is externally filled with samples, therefore does not update the internal delay line.
• Returns :
  • The filter output sample.
• Input Parameters :
  • drlms : pointer to asptDrlms32f filter
  • des : new desired sample
• Remarks :
  • The error sample is stored internally and can be retrieved by calling drlms32fGetLastErrorSample().

<< Back to top

drlms32fFilterOnly

DT32F drlms32fFilterOnly (asptDrlms32f *drlms, DT32F inp)

Calculates the filter output but does not updates the coefficients.
• Returns :
  • The filter output sample.
• Input Parameters :
  • drlms : pointer to asptDrlms32f filter
  • inp : new input sample.
• Remarks :
  • error sample is not calculated.

<< Back to top

drlms32fLCFilterOnly

DT32F drlms32fLCFilterOnly(asptDrlms32f *drlms)

Calculates the filter output but does not updates the coefficients for the Linear Combiner Configuration. Assumes that the data delay line is externally filled with samples, therefore does not update the internal delay line.
• Returns :
  • The filter output sample.
• Input Parameters :
  • drlms : pointer to asptDrlms32f filter
• Remarks :
  • error sample is not calculated.

<< Back to top

drlms32fFree

void drlms32fFree(asptDrlms32f *drlms)

Frees the allocated memory for this drlms filter.
• Returns :
  • void
• Input Parameters :
  • drlms : pointer to asptDrlms32f filter
• Remarks :
  • Use this function only with filters created with drlms32fInit(). Do not use with asptDrlms32f filters created using drlms32fInitStatic().

<< Back to top

drlms32fReset

DT32S drlms32fReset(asptDrlms32f *drlms)

Resets all filter coefficients to zero.
• Returns :
  • Error code
• Input Parameters :
  • drlms : pointer to asptDrlms32f filter to be reset
• Error Conditions
  • ASPT_NO_ERR : success
  • ASPT_NULL_PTR_ERR : NULL pointer error

<< Back to top

drlms32fResetDelayLine

DT32S drlms32fResetDelayLine(asptDrlms32f *drlms)

Resets all internal delay lines to zero.
• Returns :
  • Error code
• Input Parameters :
  • drlms : pointer to asptDrlms32f filter to be reset
• Error Conditions
  • ASPT_NO_ERR : success
  • ASPT_NULL_PTR_ERR : NULL pointer error

<< Back to top

drlms32fGetCoef

DT32S drlms32fGetCoef(asptDrlms32f *drlms, DT32F *buf, DT32S ind, DT32S N, DT32S flip)

Copies N internal filter coefficients starting from coef[ind] to dstBuf.
• Returns :
  • On success returns the number of coefficients copied, otherwise the error code (negative int).
• Input Parameters :
  • drlms : pointer to asptDrlms32f filter.
  • dstBuf : destination buffer.
  • ind : index to the first coefficient to be copied.
  • N : number of coefficients to be copied.
  • flip : if not 0, will flip the coefficients order
• Output Parameters :
  • dstBuf is updated
• Error Conditions
  • ASPT_NULL_PTR_ERR : dstBuf/drlms->coef is a NULL pointer
  • ASPT_RANGE_ERR : ind/N is not a valid input value

<< Back to top

drlms32fSetCoef

DT32S drlms32fSetCoef(asptDrlms32f *drlms, DT32F *newCoef, DT32S ind, DT32S N, DT32S flip)

Initializes N internal filter coefficients starting from coef[ind] to the contents of newBuf.
• Returns :
  • On success returns the number of coefficients initialized, otherwise the error code (negative int).
• Input Parameters :
  • drlms : pointer to asptDrlms32f filter to be set.
  • newCoef : new coefficients vector.
  • ind : index to the first coefficient to be set.
  • N : number of coefficients to be set.
  • flip : if not 0, will copy the coefficients in reverse order
• Output Parameters :
  • drlms->coef is updated
• Error Conditions
  • ASPT_NULL_PTR_ERR : newCoef/drlms->coef is a NULL pointer
  • ASPT_RANGE_ERR : ind/N is not a valid input value

<< Back to top

drlms32fGetDelayLine

DT32S drlms32fGetDelayLine(asptDrlms32f *drlms, DT32F *buf, DT32S ind, DT32S N, DT32S flip)

Copies N internal delay line samples starting from delayLine[ind] to dstBuf.
• Returns :
  • On success returns the number of samples copied, otherwise the error code (negative int).
• Input Parameters :
  • drlms : pointer to asptDrlms32f filter.
  • dstBuf : destination buffer.
  • ind : index to the first sample to be copied.
  • N : number of samples to be copied.
  • flip : if not 0, will flip the samples order.
• Output Parameters :
  • dstBuf is updated
• Error Conditions
  • ASPT_NULL_PTR_ERR : dstBuf/drlms->delayLine is a NULL pointer
  • ASPT_RANGE_ERR : ind/N is not a valid input value
• Remarks :
  • Samples are stored in dstBuf with newest sample at index 0, and oldest at index N-1, when flip == 0.

<< Back to top

drlms32fSetDelayLine

DT32S drlms32fSetDelayLine(asptDrlms32f *drlms, DT32F *newCoef, DT32S ind, DT32S N, DT32S flip)

Initializes N internal delay line samples starting from delayLine[ind] to the contents of the given array.
• Returns :
  • On success returns the number of samples initialized, otherwise the error code (negative int).
• Input Parameters :
  • drlms : pointer to asptDrlms32f filter.
  • newBuf : new data buffer.
  • ind : index to the first sample to be copied.
  • N : number of samples to be copied.
  • flip : if not 0, will flip the samples order.
• Output Parameters :
  • drlms->delayLine is updated
• Error Conditions
  • ASPT_NULL_PTR_ERR : newBuf/drlms->delayLine is a NULL pointer
  • ASPT_RANGE_ERR : ind/N is not a valid input value
• Remarks :
  • Samples assumed to be stored in newBuf with newest sample at index 0, and oldest at index N-1, when flip == 0.

<< Back to top

drlms32fResize

DT32S drlms32fResize(asptDrlms32f *drlms, DT32S newLength)

Resizes an asptDrlms32f filter keeping as much of the filter state as possible.
• Returns :
  • Error code.
• Input Parameters :
  • drlms : pointer to the asptDrlms32f filter to be resized.
  • newLen : required new filter length.
• Error Conditions
  • ASPT_NO_ERR : Resizing is success
  • ASPT_NULL_PTR_ERR : NULL pointer error
  • ASPT_RANGE_ERR : newLength is not a valid input value
  • ASPT_NO_MEM_ERR : Could not allocate the necessary filter storage
• Remarks :
  • Use this function only with dynamically allocated asptDrlms32f filters.