asptNlms32f

API Summary

• DT32S nlms32fInit (asptNlms32f *nlms,DT32S L, DT32F mu)
  
• DT32S nlms32fInitStatic(asptNlms32f *nlms,DT32S L, DT32F mu, DT32F *pCof, DT32F *pDat)
  
• void nlms32fFree(asptNlms32f *nlms)
  

• DT32F nlms32fFilterUpdate(asptNlms32f *nlms, DT32F inp, DT32F des)
  
• DT32F nlms32fFilterOnly (asptNlms32f *nlms, DT32F inp)
  
• DT32F nlms32fLCFilterUpdate(asptNlms32f *nlms, DT32F des)
  
• DT32F nlms32fLCFilterOnly (asptNlms32f *nlms)
  

• DT32S nlms32fGetCoef(asptNlms32f *nlms, DT32F *buf, DT32S ind, DT32S N, DT32S flip)
  
• DT32S nlms32fGetDelayLine(asptNlms32f *nlms, DT32F *buf, DT32S ind, DT32S N, DT32S flip)
  
• nlms32fGetCoefPtr( asptNlms32f *nlms )
• nlms32fGetFilterLength( asptNlms32f *nlms )
• nlms32fGetDelayLineLength( asptNlms32f *nlms )
• nlms32fGetLastErrorSample( asptNlms32f *nlms )
• nlms32fGetStepSize( asptNlms32f *nlms )

• DT32S nlms32fReset(asptNlms32f *nlms)
  
• DT32S nlms32fResetDelayLine(asptNlms32f *nlms)
  
• DT32S nlms32fResize(asptNlms32f *nlms, DT32S newLength)
  
• DT32S nlms32fSetCoef(asptNlms32f *nlms, DT32F *newCoef, DT32S ind, DT32S N, DT32S flip)
  
• DT32S nlms32fSetDelayLine(asptNlms32f *nlms, DT32F *newCoef, DT32S ind, DT32S N, DT32S flip)
  
• nlms32fSetStepSize( asptNlms32f *nlms, newStep )

Description

Copyright

<< Back to top

nlms32fInit

DT32S nlms32fInit (asptNlms32f *nlms,DT32S L, DT32F mu)

Initializes an asptNlms32f filter and allocates its necessary storage buffers.
• Returns :
  • Error code. On failure, the filterLength member of the filter is set to zero.
• Input Parameters :
  • nlms : asptNlms32f filter to be initialized
  • L : number of filter coefficients
  • mu : step size.
• Error Conditions
  • ASPT_NO_ERR : Initialization is successful
  • ASPT_RANGE_ERR : L is not a valid input value
  • ASPT_NO_MEM_ERR : could not allocate memory

<< Back to top

nlms32fInitStatic

DT32S nlms32fInitStatic(asptNlms32f *nlms,DT32S L, DT32F mu, DT32F *pCof, DT32F *pDat)

Initializes an asptNlms32f filter to use pre-allocated memory.
• Returns :
  • Error code. On failure, the filterLength member of the filter is set to zero.
• Input Parameters :
  • nlms : asptNlms32f filter to be initialized
  • L : number of filter coefficients
  • mu : step size.
  • 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 is not a valid input value
  • ASPT_NO_MEM_ERR : could not allocate memory

<< Back to top

nlms32fFilterUpdate

DT32F nlms32fFilterUpdate(asptNlms32f *nlms, DT32F inp, DT32F des)

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

<< Back to top

nlms32fFilterOnly

DT32F nlms32fFilterOnly (asptNlms32f *nlms, DT32F inp)

Calculates the filter output but does not updates the coefficients. It also updates the input power.
• Returns :
  • The filter output sample.
• Input Parameters :
  • nlms : pointer to the asptNlms32f filter
  • inp : new input sample.
• Remarks :
  • error sample is not calculated.

<< Back to top

nlms32fLCFilterUpdate

DT32F nlms32fLCFilterUpdate(asptNlms32f *nlms, DT32F des)

Calculates the filter output and updates the coefficients vector according to the Normalized LMS algorithm for the Linear Combiner filter configuration. Assumes the delay line has been already updated before calling this function.
• Returns :
  • The filter output sample.
• Input Parameters :
  • nlms : pointer to the asptNlms32f filter
  • des : new desired sample
• Remarks :
  • The error sample is stored internally and can be retrieved by calling nlms32fGetLastErrorSample().

<< Back to top

nlms32fFilterOnly

DT32F nlms32fFilterOnly (asptNlms32f *nlms, DT32F inp)

Calculates the filter output but does not updates the coefficients. It also updates the input power for the Linear Combiner filter configuration. Assumes the delay line has been already updated before calling this function.
• Returns :
  • The filter output sample.
• Input Parameters :
  • nlms : pointer to the asptNlms32f filter
• Remarks :
  • error sample is not calculated.

<< Back to top

nlms32fFree

void nlms32fFree(asptNlms32f *nlms)

Frees the allocated memory for this asptNlms32f filter.
• Returns :
  • void
• Input Parameters :
  • nlms : pointer to the asptNlms32f filter
• Remarks :
  • Use this function only with filters created with nlms32fInit(). Do not use with asptNlms32f filters created using nlms32fInitStatic().

<< Back to top

nlms32fReset

DT32S nlms32fReset(asptNlms32f *nlms)

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

<< Back to top

nlms32fResetDelayLine

DT32S nlms32fResetDelayLine(asptNlms32f *nlms)

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

<< Back to top

nlms32fGetCoef

DT32S nlms32fGetCoef(asptNlms32f *nlms, 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 :
  • nlms : pointer to an asptNlms32f 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/nlms->coef is a NULL pointer
  • ASPT_RANGE_ERR : ind/N is not a valid input value

<< Back to top

nlms32fSetCoef

DT32S nlms32fSetCoef(asptNlms32f *nlms, 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 :
  • nlms : pointer to an asptNlms32f 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 :
  • nlms->coef is updated
• Error Conditions
  • ASPT_NULL_PTR_ERR : newCoef/nlms->coef is a NULL pointer
  • ASPT_RANGE_ERR : ind/N is not a valid input value

<< Back to top

nlms32fGetDelayLine

DT32S nlms32fGetDelayLine(asptNlms32f *nlms, 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 :
  • nlms : pointer to the asptNlms32f 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/nlms->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

nlms32fSetDelayLine

DT32S nlms32fSetDelayLine(asptNlms32f *nlms, 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 :
  • nlms : pointer to an asptNlms32f 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 :
  • nlms->delayLine is updated
• Error Conditions
  • ASPT_NULL_PTR_ERR : newBuf/nlms->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

nlms32fResize

DT32S nlms32fResize(asptNlms32f *nlms, DT32S newLength)

Resizes an asptNlms32f filter keeping as much of the filter state as possible.
• Returns :
  • Error code.
• Input Parameters :
  • nlms : pointer to the asptNlms32f 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 asptNlms32f filters.