gr-digitalhf/include/digitalhf/adaptive_dfe.h

/* -*- c++ -*- */
/*
 * Copyright 2018 hcab14@mail.com.
 *
 * 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_DIGITALHF_ADAPTIVE_DFE_H
#define INCLUDED_DIGITALHF_ADAPTIVE_DFE_H

#include <digitalhf/api.h>
#include <gnuradio/block.h>

namespace gr {
namespace digitalhf {

/*!
 * \brief <+description of block+>
 * \ingroup digitalhf
 *
 */
class DIGITALHF_API adaptive_dfe : virtual public gr::block
{
  public:
  typedef boost::shared_ptr<adaptive_dfe> sptr;

  virtual ~adaptive_dfe() {}
  /*!
   * \brief Return a shared_ptr to a new instance of digitalhf::adaptive_dfe.
   *
   * To avoid accidental use of raw pointers, digitalhf::adaptive_dfe's
   * constructor is in a private implementation
   * class. digitalhf::adaptive_dfe::make is the public interface for
   * creating new instances.
   */
  static sptr make(int sps, // samples per symbol
                   int nB,  // number of forward FIR taps
                   int nF,  // number of backward FIR taps
                   int nW,  // number of feedback symbol taps
                   float mu,     // mu    - decision-feedback equalizer
                   float alpha); // alpha - decision-feedback equalizer

  virtual void set_mu(float) = 0;
  virtual void set_alpha(float) = 0;
} ;

} // namespace digitalhf
} // namespace gr

#endif /* INCLUDED_DIGITALHF_ADAPTIVE_DFE_H */