GPLIB++
Public Member Functions | List of all members
gplib::AMRLSCanceller Class Reference

An implementation of the Recursive Least Squares filter with adptive memory as described in Hakin, p. 663. More...

#include <AMRLSCanceller.h>

Inheritance diagram for gplib::AMRLSCanceller:
Inheritance graph
[legend]

Public Member Functions

virtual void AdaptFilter (const gplib::rvec &Input, const gplib::rvec &Desired)
 Adapt the filter weights given the Input and Desired vectors. More...
 
 AMRLSCanceller (const int inputsize, const double MyDelta, const double MyLambda, const double MyAlpha)
 
virtual ~AMRLSCanceller ()
 
- Public Member Functions inherited from gplib::RLSCanceller
void SetLambda (const double Mylambda)
 Set the forgetting factor $ \lambda $, usually $ \lambda \ll 1 $. More...
 
double GetLambda ()
 Get the current forgetting factor. More...
 
void SetDelta (const double Mydelta)
 Set the regularization factor. More...
 
double GetDelta ()
 
 RLSCanceller (const int inputsize)
 
 RLSCanceller (const int inputsize, const double MyDelta, const double MyLambda)
 
virtual ~RLSCanceller ()
 
- Public Member Functions inherited from gplib::LSSOFilter
virtual void CalcOutput (const gplib::rvec &Input, gplib::rvec &Output)
 The way to calculate the output is the same for all single output filters, we implement it here. More...
 
double CalcOutput (const gplib::rvec &Input)
 For single channel output we can also just return the output as a double. More...
 
const gplib::rvec & GetWeights ()
 Return the current set of weights. More...
 
virtual const gplib::rvec & GetWeightsAsVector ()
 Implement the abstract function from adaptive filter, in this case just another name for GetWeights. More...
 
virtual void PrintWeights (std::ostream &output)
 Print the weights to output stream. More...
 
 LSSOFilter (const int filterlength)
 The constructor only needs the filter length, outputsize for Adaptive filter is 1. More...
 
virtual ~LSSOFilter ()
 
- Public Member Functions inherited from gplib::AdaptiveFilter
const gplib::rvec & GetFilterOutput () const
 Access to the last calculated output (not sure if needed) More...
 
const gplib::rvec & GetEpsilon () const
 Return the last estimation error. More...
 
 AdaptiveFilter (const int inputsize, const int outputsize)
 The constructor needs to know the length of the input and output vectors for memory allocation. More...
 
virtual ~AdaptiveFilter ()
 

Additional Inherited Members

- Protected Member Functions inherited from gplib::RLSCanceller
const gplib::rmat & GetP ()
 
const gplib::rvec & GetPi ()
 
const gplib::rvec & GetK ()
 
- Protected Member Functions inherited from gplib::LSSOFilter
gplib::rvec & SetWeights ()
 
- Protected Member Functions inherited from gplib::AdaptiveFilter
unsigned int GetInputLength ()
 Access function for derived classes for the inputlength. More...
 
unsigned int GetOutputLength ()
 Access function for derived classes for the outputlength. More...
 
void SetEpsilon (const gplib::rvec &MyEps)
 Possibility for derived classes to set estimation error. More...
 
void SetOutput (const gplib::rvec &Out)
 Possibility for derived classes to set output. More...
 

Detailed Description

An implementation of the Recursive Least Squares filter with adptive memory as described in Hakin, p. 663.

Definition at line 14 of file AMRLSCanceller.h.

Constructor & Destructor Documentation

gplib::AMRLSCanceller::AMRLSCanceller ( const int  inputsize,
const double  MyDelta,
const double  MyLambda,
const double  MyAlpha 
)

Definition at line 11 of file AMRLSCanceller.cpp.

gplib::AMRLSCanceller::~AMRLSCanceller ( )
virtual

Definition at line 22 of file AMRLSCanceller.cpp.

Member Function Documentation

void gplib::AMRLSCanceller::AdaptFilter ( const gplib::rvec &  Input,
const gplib::rvec &  Desired 
)
virtual

The documentation for this class was generated from the following files: