qrd_rls_filter_ff.h
Go to the documentation of this file.
/* -*- c++ -*- */
/*
* Copyright 2019 <+YOU OR YOUR COMPANY+>.
*
* This is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3, or (at your option)
* any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this software; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street,
* Boston, MA 02110-1301, USA.
*/
#ifndef INCLUDED_ADAPT_QRD_RLS_FILTER_FF_H
#define INCLUDED_ADAPT_QRD_RLS_FILTER_FF_H
#include <adapt/api.h>
#include <gnuradio/sync_decimator.h>
namespace gr {
namespace adapt {
/*!
* \brief QR Decomposition Recursive Least Squares Adaptive Filter (float in/out)
* \ingroup adapt
*
* \details
* This block implements a QRD-RLS-based adaptive filter.
*/
class ADAPT_API qrd_rls_filter_ff : virtual public gr::sync_decimator {
public:
typedef boost::shared_ptr<qrd_rls_filter_ff> sptr;
/*!
* Make a QRD-RLS adaptive filter
*
* \param num_taps Number of taps in the filter (int)
* \param delta Regularization factor of the update loop (float)
* \param _lambda Forgetting factor of the update loop (float)
* \param skip Specifies how many samples are skipped between
* successive filter updates (unsigned)
* \param decimation Decimation rate of the filter (unsigned)
* \param adapt Controls whether filter taps are being updated (bool)
* \param reset Reset filter taps (bool)
*/
static sptr make(int num_taps,
float delta,
float _lambda,
unsigned skip,
unsigned decimation,
bool adapt,
bool reset);
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;
};
} // namespace adapt
} // namespace gr
#endif /* INCLUDED_ADAPT_QRD_RLS_FILTER_FF_H */
api.h
ADAPT_API
#define ADAPT_API
Definition: api.h:31
gr::adapt::qrd_rls_filter_ff
QR Decomposition Recursive Least Squares Adaptive Filter (float in/out)
Definition: qrd_rls_filter_ff.h:38
gr::adapt::qrd_rls_filter_ff::set_adapt
virtual void set_adapt(bool adapt)=0
gr::adapt::qrd_rls_filter_ff::sptr
boost::shared_ptr< qrd_rls_filter_ff > sptr
Definition: qrd_rls_filter_ff.h:40
gr::adapt::qrd_rls_filter_ff::set_reset
virtual void set_reset(bool reset)=0
gr::adapt::qrd_rls_filter_ff::get_reset
virtual bool get_reset() const =0
gr::adapt::qrd_rls_filter_ff::set_delta
virtual void set_delta(float delta)=0
gr::adapt::qrd_rls_filter_ff::make
static sptr make(int num_taps, float delta, float _lambda, unsigned skip, unsigned decimation, bool adapt, bool reset)
gr::adapt::qrd_rls_filter_ff::set_taps
virtual void set_taps(const std::vector< float > &taps)=0
gr::adapt::qrd_rls_filter_ff::get_skip
virtual unsigned get_skip() const =0
gr::adapt::qrd_rls_filter_ff::get_adapt
virtual bool get_adapt() const =0
gr::adapt::qrd_rls_filter_ff::get_taps
virtual const std::vector< float > & get_taps()=0
gr::adapt::qrd_rls_filter_ff::get_lambda
virtual float get_lambda() const =0
gr::adapt::qrd_rls_filter_ff::set_skip
virtual void set_skip(unsigned skip)=0
gr::adapt::qrd_rls_filter_ff::get_delta
virtual float get_delta() const =0
gr::adapt::qrd_rls_filter_ff::set_lambda
virtual void set_lambda(float _lambda)=0
gr
Definition: iqrd_rls_filter_cc.h:28