IIR.H

Go to the documentation of this file.

/* Copyright 2000-2018 Matt Flax <flatmax@flatmax.org>
   This file is part of GTK+ IOStream class set

   GTK+ IOStream 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 2 of the License, or
   (at your option) any later version.

   GTK+ IOStream 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 have received a copy of the GNU General Public License
   along with GTK+ IOStream
*/

#ifndef IIR_H
#define IIR_H

// Debug
#include "Debug.H"
#define IIR_A0_ERROR IIR_ERROR_OFFSET-1 
#define IIR_CH_CNT_ERROR IIR_ERROR_OFFSET-2 
#define IIR_N_CNT_ERROR IIR_ERROR_OFFSET-3 
#define IIR_REQUIRE_COL_ERROR IIR_ERROR_OFFSET-4 
#define IIR_REQUIRE_MATRIX_ERROR IIR_ERROR_OFFSET-5 

class IIRDebug :  virtual public Debug  {
public:
    IIRDebug(){
#ifndef NDEBUG
        errors[IIR_A0_ERROR]=std::string("IIR feedback coefficient a0 != 1. ");
        errors[IIR_CH_CNT_ERROR]=std::string("The channel counts aren't the same. ");
        errors[IIR_N_CNT_ERROR]=std::string("The sample counts aren't the same. ");
        errors[IIR_REQUIRE_COL_ERROR]=std::string("The Matrix must be defined as a single col matrix, not dynamic. ");
        errors[IIR_REQUIRE_MATRIX_ERROR]=std::string("The Matrix must be defined as a Matrix, not Array. ");

#endif // NDEBUG
    }
};

#include <Eigen/Dense>
#include <strstream>

class IIR {
protected:
    Eigen::Array<double, Eigen::Dynamic, Eigen::Dynamic> B; // feed forward
    Eigen::Array<double, Eigen::Dynamic, Eigen::Dynamic> A; // feed back
    Eigen::Matrix<double, Eigen::Dynamic, Eigen::Dynamic> yTemp; // temporary output variables
    Eigen::Array<double, Eigen::Dynamic, Eigen::Dynamic> mem; // memory

public:
    IIR();
    virtual ~IIR();
    int reset(const Eigen::Array<double, Eigen::Dynamic, Eigen::Dynamic> &Bin, const Eigen::Array<double, Eigen::Dynamic, Eigen::Dynamic> &Ain);
    // int reset(const Eigen::Array<double, Eigen::Dynamic, Eigen::Dynamic> &Bin, const Eigen::Array<double, Eigen::Dynamic, Eigen::Dynamic> &Ain, Eigen::Dynamic, Eigen::Dynamic> &memIn);
    int reset(){
        mem.setZero();
        return 0;
    }
    int setMem(const Eigen::Array<double, Eigen::Dynamic, Eigen::Dynamic> &memIn);
    int setMem(const IIR &iir);
    void resetMem(){mem.setZero();}

    int process(const Eigen::Matrix<double, Eigen::Dynamic, Eigen::Dynamic> &x, Eigen::Matrix<double, Eigen::Dynamic, Eigen::Dynamic> const &y);
    int process(const Eigen::Matrix<double, Eigen::Dynamic, Eigen::Dynamic> &x, Eigen::Matrix<double, Eigen::Dynamic, Eigen::Dynamic> const &y,
                const Eigen::Array<double, Eigen::Dynamic, Eigen::Dynamic> &BStep, const Eigen::Array<double, Eigen::Dynamic, Eigen::Dynamic> &AStep);
    int getChannelCount(){return B.cols();}

    // int IIR::copyTo(IIR iirIn);

    Eigen::Array<double, Eigen::Dynamic, Eigen::Dynamic> getB(){return B;}
    Eigen::Array<double, Eigen::Dynamic, Eigen::Dynamic> getA(){return A;}
    Eigen::Array<double, Eigen::Dynamic, Eigen::Dynamic> getMem(){return mem;}
};
#endif // IIR_H