/*
 * Copyright (c) 2007 - 2026 Joseph Gaeddert
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#include "liquid.autotest.h"
#include "liquid.h"

// constant data sequence
const float eqrls_rrrf_autotest_data_sequence[64] = {
    -1.0, -1.0,  1.0, -1.0,  1.0, -1.0,  1.0, -1.0, 
    -1.0,  1.0,  1.0, -1.0, -1.0,  1.0, -1.0,  1.0, 
     1.0, -1.0, -1.0, -1.0,  1.0,  1.0, -1.0,  1.0, 
    -1.0,  1.0,  1.0,  1.0,  1.0,  1.0, -1.0, -1.0,
     1.0,  1.0, -1.0, -1.0,  1.0, -1.0,  1.0, -1.0, 
    -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, 
     1.0, -1.0, -1.0, -1.0,  1.0,  1.0, -1.0,  1.0, 
    -1.0,  1.0,  1.0, -1.0,  1.0, -1.0,  1.0, -1.0
};

LIQUID_AUTOTEST(eqrls_rrrf_01,"eqrls channel filter (delta with zero delay)","",0.1)
{
    float tol=1e-2f;        // error tolerance

    // fixed parameters (do not change)
    unsigned int h_len=4;   // channel filter length
    unsigned int p=6;       // equalizer order
    unsigned int n=64;      // number of symbols to observe

    // bookkeeping variables
    float y[n];         // received data sequence (filtered by channel)
    //float d_hat[n];   // recovered data sequence
    float h[h_len];     // channel filter coefficients
    float w[p];         // equalizer filter coefficients
    unsigned int i;

    // create equalizer
    eqrls_rrrf eq = eqrls_rrrf_create(NULL, p);

    // create channel filter
    h[0] = 1.0f;
    for (i=1; i<h_len; i++)
        h[i] = 0.0f;
    firfilt_rrrf f = firfilt_rrrf_create(h,h_len);

    // data sequence
    float *d = (float*) eqrls_rrrf_autotest_data_sequence;

    // filter data signal through channel
    for (i=0; i<n; i++) {
        firfilt_rrrf_push(f,d[i]);
        firfilt_rrrf_execute(f,&y[i]);
    }

    // initialize weights, train equalizer
    for (i=0; i<p; i++)
        w[i] = 0;
    eqrls_rrrf_train(eq, w, y, d, n);

    // compare filter taps
    LIQUID_CHECK_DELTA(w[0], 1.0f, tol);
    for (i=1; i<p; i++)
        LIQUID_CHECK_DELTA(w[i], 0.0f, tol);

    // clean up objects
    firfilt_rrrf_destroy(f);
    eqrls_rrrf_destroy(eq);
}

LIQUID_AUTOTEST(eqrls_rrrf_copy,"test copying eqrls object","",0.1)
{
    // create initial object
    unsigned int i;
    float h[9];
    for (i=0; i<9; i++)
        h[i] = randnf();
    eqrls_rrrf q0 = eqrls_rrrf_create(h, 9);

    // create channel filter
    float hc[7] = {1.0f,-0.08f, 0.32f, 0.01f,-0.06f, 0.07f,-0.03f,};
    firfilt_rrrf fc = firfilt_rrrf_create(hc,7);

    // run training samples through object
    float v, y0, y1, nstd = 0.001f;
    float * d = (float*)eqrls_rrrf_autotest_data_sequence;
    for (i=0; i<64; i++) {
        firfilt_rrrf_execute_one(fc, d[i], &v);
        v += nstd*randnf();
        eqrls_rrrf_push   (q0, v);
        eqrls_rrrf_execute(q0, &y0);
        eqrls_rrrf_step   (q0, d[i], y0);
    }

    // copy object
    eqrls_rrrf q1 = eqrls_rrrf_copy(q0);

    // run training samples through object
    for (i=0; i<64; i++) {
        // filtered sample in noise
        firfilt_rrrf_execute_one(fc, d[i], &v);
        v += nstd*randnf();

        // push sample through filter
        eqrls_rrrf_push(q0, v);
        eqrls_rrrf_push(q1, v);

        // compute output
        eqrls_rrrf_execute(q0, &y0);
        eqrls_rrrf_execute(q1, &y1);
        LIQUID_CHECK(y0 ==  y1);

        // step equalization algorithm
        eqrls_rrrf_step(q0, d[i], y0);
        eqrls_rrrf_step(q1, d[i], y1);
    }

    // get and compare coefficients
    //LIQUID_CHECK_ARRAY(eqrls_rrrf_get_coefficients(q0),
    //                  eqrls_rrrf_get_coefficients(q1),
    //                  21 * sizeof(float));

    // destroy filter objects
    firfilt_rrrf_destroy(fc);
    eqrls_rrrf_destroy(q0);
    eqrls_rrrf_destroy(q1);
}

