GNU Radio's ADAPT Package
gr::adapt::rls_filter_ff Class Referenceabstract

Recursive Least Squares Adaptive Filter (float in/out) More...

#include <rls_filter_ff.h>

Inheritance diagram for gr::adapt::rls_filter_ff:

Public Types

typedef boost::shared_ptr< rls_filter_ffsptr
 

Public Member Functions

virtual void set_taps (const std::vector< float > &taps)=0
 
virtual const std::vector< float > & get_taps ()=0
 
virtual float get_delta () const =0
 
virtual void set_delta (float delta)=0
 
virtual float get_lambda () const =0
 
virtual void set_lambda (float _lambda)=0
 
virtual unsigned get_skip () const =0
 
virtual void set_skip (unsigned skip)=0
 
virtual bool get_adapt () const =0
 
virtual void set_adapt (bool adapt)=0
 
virtual bool get_reset () const =0
 
virtual void set_reset (bool reset)=0
 

Static Public Member Functions

static sptr make (bool first_input, int num_taps, float delta, float _lambda, unsigned skip, unsigned decimation, bool adapt, bool reset)
 

Detailed Description

Recursive Least Squares Adaptive Filter (float in/out)

This block implements a RLS-based adaptive filter.

Member Typedef Documentation

◆ sptr

typedef boost::shared_ptr<rls_filter_ff> gr::adapt::rls_filter_ff::sptr

Member Function Documentation

◆ get_adapt()

virtual bool gr::adapt::rls_filter_ff::get_adapt ( ) const
pure virtual

◆ get_delta()

virtual float gr::adapt::rls_filter_ff::get_delta ( ) const
pure virtual

◆ get_lambda()

virtual float gr::adapt::rls_filter_ff::get_lambda ( ) const
pure virtual

◆ get_reset()

virtual bool gr::adapt::rls_filter_ff::get_reset ( ) const
pure virtual

◆ get_skip()

virtual unsigned gr::adapt::rls_filter_ff::get_skip ( ) const
pure virtual

◆ get_taps()

virtual const std::vector< float > & gr::adapt::rls_filter_ff::get_taps ( )
pure virtual

◆ make()

static sptr gr::adapt::rls_filter_ff::make ( bool  first_input,
int  num_taps,
float  delta,
float  _lambda,
unsigned  skip,
unsigned  decimation,
bool  adapt,
bool  reset 
)
static

Make a RLS adaptive filter

Parameters
first_inputSpecifies whether first input is reference or error signal (bool)
num_tapsNumber of taps in the filter (int)
deltaRegularization factor of the update loop (float)
_lambdaForgetting factor of the update loop (float)
skipSpecifies how many samples are skipped between successive filter updates (unsigned)
decimationDecimation rate of the filter (unsigned)
adaptControls whether filter taps are being updated (bool)
resetReset filter taps (bool)

◆ set_adapt()

virtual void gr::adapt::rls_filter_ff::set_adapt ( bool  adapt)
pure virtual

◆ set_delta()

virtual void gr::adapt::rls_filter_ff::set_delta ( float  delta)
pure virtual

◆ set_lambda()

virtual void gr::adapt::rls_filter_ff::set_lambda ( float  _lambda)
pure virtual

◆ set_reset()

virtual void gr::adapt::rls_filter_ff::set_reset ( bool  reset)
pure virtual

◆ set_skip()

virtual void gr::adapt::rls_filter_ff::set_skip ( unsigned  skip)
pure virtual

◆ set_taps()

virtual void gr::adapt::rls_filter_ff::set_taps ( const std::vector< float > &  taps)
pure virtual

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