comnum-waveform 0.3.1

//! Channel estimation on the OFDM resource grid.
//!
//! The receiver knows the pilots: LS estimates $\hat H = Y / X$ at the pilot REs, then an
//! interpolation over the grid — first across the subcarriers of every pilot-carrying
//! symbol, then across the symbols of every subcarrier (linear in time, constant beyond
//! the first and last pilot symbols).
//!
//! - [`FrequencyInterpolation::Linear`]: linear between pilot subcarriers;
//! - [`FrequencyInterpolation::SecondOrder`], [`FrequencyInterpolation::Spline`],
//!   [`FrequencyInterpolation::LowPass`] and [`FrequencyInterpolation::TimeDomain`]: the
//!   interpolations compared by Coleri et al. (2002), the quadratic through three
//!   pilots, the not-a-knot cubic spline, the band-limited interpolator of MATLAB
//!   `interp` and the zero padding of the IDFT of the pilot estimates (a comb of
//!   pilots on subcarriers $0, L, \dots$ of a grid of a multiple of $L$ subcarriers);
//! - [`FrequencyInterpolation::Lmmse`]: the linear MMSE estimator of
//!   `comnum_dsp::estimation` with the frequency correlation of a power-delay profile,
//!   $R(\Delta k) = \sum_{l} p_{l}\, e^{-j 2\pi \Delta k\, d_{l} / N}$ — the true profile, or the
//!   uniform profile over the cyclic prefix of the robust design (Edfors et al. 1998).
//!
//! With pilots on every subcarrier (block pattern) LMMSE still smooths the LS estimates
//! (van de Beek et al. 1995); with a comb it interpolates them.
//!
//! The LMMSE estimator and the band-limited interpolator are built once per set of pilot
//! subcarriers (`super::wiener::Wiener2d` on the pilots of the symbol, `comnum_dsp::interpolation::LowPassInterpolator`) and
//! applied to every pilot symbol that shares it.
//!
//! # Examples
//! ```
//! use comnum_waveform::ofdm::estimation::{estimate, FrequencyInterpolation};
//! use comnum_waveform::ofdm::grid::{PilotPattern, ResourceGrid};
//! use comnum_math::C64;
//! let g = ResourceGrid { n_subcarriers: 16, n_symbols: 4, pattern: PilotPattern::Comb { spacing: 4 }, seed: 3 };
//! // a flat channel 0.5 + 0.5j, no noise: the estimate is exact everywhere
//! let h = C64::new(0.5, 0.5);
//! let tx = g.map(&vec![C64::new(1.0, 0.0); g.n_data()])?;
//! let rx: Vec<C64> = tx.iter().map(|x| x * h).collect();
//! let est = estimate(&g, &rx, 1e-6, &FrequencyInterpolation::Linear)?;
//! assert!(est.iter().all(|e| (e - h).norm() < 1e-9));
//! # Ok::<(), comnum_core::Error>(())
//! ```
//!
//! # References
//!
//! 1. J.-J. van de Beek, O. Edfors, M. Sandell, S. K. Wilson and P. O. Börjesson, "On
//!    channel estimation in OFDM systems," *Proc. IEEE VTC*, 815–819, 1995.
//! 2. O. Edfors, M. Sandell, J.-J. van de Beek, S. K. Wilson and P. O. Börjesson, "OFDM
//!    channel estimation by singular value decomposition," *IEEE Trans. Commun.*, 46(7),
//!    931–939, 1998.
//! 3. S. Coleri, M. Ergen, A. Puri and A. Bahai, "Channel estimation techniques based on
//!    pilot arrangement in OFDM systems," *IEEE Trans. Broadcast.*, 48(3), 223–229, 2002.

use super::grid::ResourceGrid;
use super::wiener::{Correlation2d, DelaySpectrum, DopplerSpectrum, Wiener2d, WienerPlan};
use comnum_core::{Error, Result, ensure, ensure_shape};
use comnum_dsp::estimation::frequency_correlation;
use comnum_dsp::interpolation::{self, LowPassInterpolator};
use comnum_dsp::resample::resample_fft;
use comnum_math::C64;
use ndarray::Array2;

/// A power-delay profile on the sampling grid of the OFDM symbol: checked when it is
/// built, its fields read through getters.
#[derive(Clone, Debug, PartialEq)]
pub struct PowerDelayProfile {
    delays: Vec<f64>,
    powers: Vec<f64>,
    n_fft: usize,
}

impl PowerDelayProfile {
    /// A profile from delays (samples of the IFFT of size `n_fft`) and linear powers,
    /// normalised to a unit sum.
    ///
    /// # Errors
    /// [`Error::Shape`] for as many delays as powers; [`Error::Config`] for no tap, a
    /// zero FFT size, a negative or non-finite delay or power, or powers of zero sum.
    ///
    /// # Examples
    /// ```
    /// use comnum_waveform::ofdm::estimation::PowerDelayProfile;
    /// let p = PowerDelayProfile::new(vec![0.0, 3.0], &[3.0, 1.0], 64)?;
    /// assert_eq!(p.powers(), &[0.75, 0.25]);
    /// assert!(PowerDelayProfile::new(vec![0.0], &[1.0, 1.0], 64).is_err());
    /// assert!(PowerDelayProfile::new(vec![0.0], &[0.0], 64).is_err());
    /// # Ok::<(), comnum_core::Error>(())
    /// ```
    pub fn new(delays: Vec<f64>, powers: &[f64], n_fft: usize) -> Result<PowerDelayProfile> {
        comnum_core::same_len(powers.len(), delays.len(), "powers and delays of the profile")?;
        ensure(!delays.is_empty() && n_fft >= 1, || "a power-delay profile needs a tap and an FFT size".into())?;
        ensure(delays.iter().all(|d| *d >= 0.0 && d.is_finite()), || {
            format!("negative or non-finite delays {delays:?}")
        })?;
        ensure(powers.iter().all(|p| *p >= 0.0 && p.is_finite()), || {
            format!("negative or non-finite powers {powers:?}")
        })?;
        let t: f64 = powers.iter().sum();
        ensure(t > 0.0, || "the powers of the profile sum to zero".into())?;
        Ok(PowerDelayProfile { delays, powers: powers.iter().map(|p| p / t).collect(), n_fft })
    }

    /// The uniform profile over `max_delay` samples (the robust design: the cyclic
    /// prefix; one tap at least).
    ///
    /// # Errors
    /// [`Error::Config`] for a zero FFT size.
    pub fn uniform(max_delay: usize, n_fft: usize) -> Result<PowerDelayProfile> {
        let n = max_delay.max(1);
        PowerDelayProfile::new((0..n).map(|d| d as f64).collect(), &vec![1.0; n], n_fft)
    }

    /// The delays (samples of the IFFT of size [`PowerDelayProfile::n_fft`]).
    pub fn delays(&self) -> &[f64] {
        &self.delays
    }

    /// The powers (linear, of unit sum).
    pub fn powers(&self) -> &[f64] {
        &self.powers
    }

    /// The IFFT size $N$ the delays refer to.
    pub fn n_fft(&self) -> usize {
        self.n_fft
    }

    /// $R(\Delta k)$ between subcarriers $\Delta k$ apart
    /// (`comnum_dsp::estimation::frequency_correlation`).
    pub fn correlation(&self, delta: f64) -> C64 {
        frequency_correlation(&self.delays, &self.powers, delta, self.n_fft)
    }
}

/// A channel of `paths` impulses whose delays are independent and uniform over
/// $[0, L]$ samples of the IFFT (`max_delay` = $L$), not on the sampling grid, of
/// power $e^{-\tau/\tau_{\mathrm{rms}}}$ (or all equal), the first one at delay 0 when
/// `first_at_zero`: the "synchronized" (exponential, first at 0) and "uniform" models of
/// Edfors et al. (1998, Sec. II). Its correlation averaged over the delays is, for one
/// random delay of power $w(\tau)$,
///
/// $$
/// E\left[w(\tau)\, e^{-j 2\pi \Delta k \tau / N}\right] = \frac{1 - e^{-aL}}{aL}, \qquad
/// a = \frac{1}{\tau_{\mathrm{rms}}} + j\frac{2\pi \Delta k}{N},
/// $$
///
/// normalised to a unit power: [`RandomDelayProfile::correlation`] and the $N \times N$
/// matrix of $N$ adjacent subcarriers, [`RandomDelayProfile::correlation_matrix`].
///
/// # Examples
/// ```
/// use comnum_waveform::ofdm::estimation::RandomDelayProfile;
/// // equal powers over a prefix of 4 samples: the correlation of a uniform delay
/// let p = RandomDelayProfile { paths: 3, max_delay: 4.0, tau_rms: None, first_at_zero: false, n_fft: 64 };
/// assert!((p.correlation(0.0).re - 1.0).abs() < 1e-15);
/// // 8 subcarriers apart, half a turn over the prefix: (1 - e^{-j pi}) / (j pi)
/// assert!((p.correlation(8.0).norm() - (2.0 / std::f64::consts::PI)).abs() < 1e-12);
/// ```
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct RandomDelayProfile {
    /// Impulses $M$.
    pub paths: usize,
    /// The largest delay $L$ (samples of the IFFT), the cyclic prefix.
    pub max_delay: f64,
    /// The decay $\tau_{\mathrm{rms}}$ (samples) of the powers, `None` for equal powers.
    pub tau_rms: Option<f64>,
    /// The first impulse at delay 0, the others random.
    pub first_at_zero: bool,
    /// The IFFT size $N$ the delays refer to.
    pub n_fft: usize,
}

impl RandomDelayProfile {
    /// $E[w(\tau) e^{-j2\pi\Delta k \tau/N}]$ for one delay uniform over $[0, L]$.
    fn random_term(&self, delta: f64) -> C64 {
        let a = C64::new(self.tau_rms.map_or(0.0, |t| 1.0 / t), 2.0 * std::f64::consts::PI * delta / self.n_fft as f64);
        let al = a * self.max_delay;
        if al.norm() < 1e-12 { C64::new(1.0, 0.0) } else { (C64::new(1.0, 0.0) - (-al).exp()) / al }
    }

    /// The correlation $R(\Delta k)$ between subcarriers $\Delta k$ apart, averaged over
    /// the delays, of unit power.
    pub fn correlation(&self, delta: f64) -> C64 {
        let random = if self.first_at_zero { self.paths.saturating_sub(1) } else { self.paths } as f64;
        let fixed = if self.first_at_zero { 1.0 } else { 0.0 };
        let total = fixed + random * self.random_term(0.0).re;
        (C64::new(fixed, 0.0) + self.random_term(delta) * random) / total
    }

    /// The correlation matrix of `n` adjacent subcarriers, $R_{ij} = R(i - j)$.
    pub fn correlation_matrix(&self, n: usize) -> Array2<C64> {
        Array2::from_shape_fn((n, n), |(i, j)| self.correlation(i as f64 - j as f64))
    }
}

/// How the pilot estimates are interpolated across the subcarriers.
#[non_exhaustive]
#[derive(Clone, Debug, PartialEq)]
pub enum FrequencyInterpolation {
    /// Linear between pilot subcarriers.
    Linear,
    /// Linear MMSE with the frequency correlation of a power-delay profile.
    Lmmse(PowerDelayProfile),
    /// The parabola through the three nearest pilots (Coleri et al. 2002, eq. (19)).
    SecondOrder,
    /// The cubic spline through the pilots, not-a-knot ends (MATLAB `spline`).
    Spline,
    /// The band-limited interpolator of MATLAB `interp` over `2 * half` pilots, for a
    /// spectrum over the fraction `alpha` of the band of the pilots (`interp`: 4, 0.5).
    LowPass {
        /// Half the number of pilots combined.
        half: usize,
        /// The fraction of the band of the pilots the channel occupies.
        alpha: f64,
    },
    /// Zero padding of the IDFT of the pilot estimates ("time-domain" interpolation,
    /// Coleri et al. 2002, eqs. (20)–(22)): pilots on the subcarriers $0, L, \dots$ of a
    /// grid of $N_{p} L$ subcarriers.
    TimeDomain,
}

impl FrequencyInterpolation {
    /// The interpolation of a name: `linear`, `lmmse` (with the profile `pdp`),
    /// `second_order`, `spline`, `lowpass` (MATLAB `interp`: `half` = 4, `alpha` = 0.5)
    /// or `time_domain`.
    ///
    /// # Errors
    /// [`Error::Config`] for another name, or for `lmmse` without a profile.
    ///
    /// # Examples
    /// ```
    /// use comnum_waveform::ofdm::estimation::FrequencyInterpolation;
    /// assert_eq!(FrequencyInterpolation::from_name("spline", None)?, FrequencyInterpolation::Spline);
    /// assert!(FrequencyInterpolation::from_name("lmmse", None).is_err());
    /// # Ok::<(), comnum_core::Error>(())
    /// ```
    pub fn from_name(name: &str, pdp: Option<PowerDelayProfile>) -> Result<FrequencyInterpolation> {
        Ok(match name.to_ascii_lowercase().as_str() {
            "linear" => FrequencyInterpolation::Linear,
            "lmmse" => FrequencyInterpolation::Lmmse(
                pdp.ok_or_else(|| Error::Config("lmmse interpolation needs a power-delay profile".into()))?,
            ),
            "second_order" => FrequencyInterpolation::SecondOrder,
            "spline" => FrequencyInterpolation::Spline,
            "lowpass" => FrequencyInterpolation::LowPass { half: 4, alpha: 0.5 },
            "time_domain" => FrequencyInterpolation::TimeDomain,
            other => {
                return Err(Error::Config(format!(
                    "unknown interpolation {other:?}: linear, lmmse, second_order, spline, lowpass, time_domain"
                )));
            }
        })
    }
}

/// The channel at every RE of the grid (symbol after symbol) from the received grid
/// `rx` (the FFT outputs of the active subcarriers), with the noise variance per RE
/// `noise_var` (used by LMMSE).
///
/// # Errors
/// [`Error::Shape`] if `rx` is not a whole grid, [`Error::Config`] without pilots.
pub fn estimate(grid: &ResourceGrid, rx: &[C64], noise_var: f64, method: &FrequencyInterpolation) -> Result<Vec<C64>> {
    estimate_port(grid, rx, &PortEstimation { method: method.clone(), noise_var, ..PortEstimation::default() })
}

/// The settings of [`estimate_port`]: the interpolation, the noise variance per RE (used
/// by LMMSE) and the transmit port among the ports of the grid.
#[derive(Clone, Debug, PartialEq)]
pub struct PortEstimation {
    /// The interpolation in frequency.
    pub method: FrequencyInterpolation,
    /// The noise variance per RE.
    pub noise_var: f64,
    /// The transmit port whose channel is estimated.
    pub port: usize,
    /// The ports of the grid ([`ResourceGrid::port_pilots`]).
    pub n_ports: usize,
}

impl Default for PortEstimation {
    /// Linear interpolation, no noise, the one port of a grid.
    fn default() -> PortEstimation {
        PortEstimation { method: FrequencyInterpolation::Linear, noise_var: 0.0, port: 0, n_ports: 1 }
    }
}

impl PortEstimation {
    /// Check the settings.
    ///
    /// # Errors
    /// [`Error::Config`] for a noise variance that is negative or not finite, or a port
    /// outside the ports of the grid.
    pub fn check(&self) -> Result<()> {
        let (v, p, n) = (self.noise_var, self.port, self.n_ports);
        ensure(v >= 0.0 && v.is_finite(), || format!("the noise variance must be finite and non-negative, got {v}"))?;
        ensure(p < n, || format!("no port {p} out of {n}"))
    }
}

/// [`estimate`] for the channel of the port of `settings`, from its pilots
/// ([`ResourceGrid::port_pilots`]): with one receive antenna's grid `rx`, the channel
/// between that antenna and the transmit port.
///
/// # Errors
/// As [`estimate`]; the errors of [`PortEstimation::check`] and of
/// [`ResourceGrid::check`]; [`Error::Config`] if a pilot symbol has no pilot of the port.
pub fn estimate_port(grid: &ResourceGrid, rx: &[C64], settings: &PortEstimation) -> Result<Vec<C64>> {
    settings.check()?;
    let PortEstimation { method, noise_var, port, n_ports } = settings;
    let (noise_var, port, n_ports) = (*noise_var, *port, *n_ports);
    grid.check()?;
    let (k_n, l_n) = (grid.n_subcarriers, grid.n_symbols);
    ensure_shape(rx.len() == k_n * l_n, || format!("{} REs for a grid of {k_n} × {l_n}", rx.len()))?;
    let symbols = grid.pilot_symbols();
    if symbols.is_empty() {
        return Err(Error::Config("the grid has no pilots".into()));
    }
    // the channel of every subcarrier at every pilot-carrying symbol; the LMMSE and
    // band-limited interpolators are built once per set of pilots (and pilot energy)
    let mut per_symbol = Vec::with_capacity(symbols.len());
    let mut lowpass_plans: Vec<(Vec<usize>, LowPassInterpolator)> = Vec::new();
    let mut lmmse_plans: Vec<((Vec<usize>, u64), WienerPlan)> = Vec::new();
    for &l in &symbols {
        let ks = grid.port_pilots(l, port, n_ports);
        if ks.is_empty() {
            return Err(Error::Config(format!("OFDM symbol {l} has no pilot of port {port} out of {n_ports}")));
        }
        let pilots: Vec<C64> = ks.iter().map(|&k| grid.pilot(k, l)).collect();
        let hp: Vec<C64> = ks.iter().zip(&pilots).map(|(&k, p)| rx[l * k_n + k] / p).collect();
        let full = match method {
            FrequencyInterpolation::Linear => interpolation::linear(&ks, &hp, k_n)?,
            FrequencyInterpolation::SecondOrder => interpolation::quadratic(&ks, &hp, k_n)?,
            FrequencyInterpolation::Spline => interpolation::spline(&ks, &hp, k_n)?,
            FrequencyInterpolation::LowPass { half, alpha } => {
                cached(&mut lowpass_plans, &ks, || LowPassInterpolator::new(&ks, k_n, *half, *alpha))?.apply(&hp)?
            }
            FrequencyInterpolation::TimeDomain => {
                let spacing = k_n / ks.len();
                if ks.iter().enumerate().any(|(i, &k)| k != i * spacing) || spacing * ks.len() != k_n {
                    return Err(Error::Config(format!(
                        "time-domain interpolation needs pilots on 0, L, 2L, … of the {k_n} subcarriers"
                    )));
                }
                resample_fft(&hp, k_n)
            }
            FrequencyInterpolation::Lmmse(pdp) => {
                // the LS estimate Y / X of a pilot of energy |X|² has the noise variance σ² / |X|²
                let energy = pilots.iter().map(C64::norm_sqr).sum::<f64>() / pilots.len() as f64;
                // the 1-D Wiener filter of every subcarrier on all the pilots of the symbol
                let plan = cached(&mut lmmse_plans, &(ks.clone(), energy.to_bits()), || {
                    let corr = Correlation2d {
                        fd_ts: 0.0,
                        doppler: DopplerSpectrum::Uniform,
                        delay: DelaySpectrum::Profile(pdp.clone()),
                    };
                    let pilots: Vec<(usize, usize)> = ks.iter().map(|&k| (0, k)).collect();
                    let targets: Vec<(usize, usize)> = (0..k_n).map(|q| (0, q)).collect();
                    Wiener2d::new(pilots, corr, noise_var / energy, ks.len())?.plan(&targets)
                })?;
                plan.apply(&hp)?
            }
        };
        per_symbol.push(full);
    }
    // linear in time
    let mut out = vec![C64::new(0.0, 0.0); k_n * l_n];
    for k in 0..k_n {
        let vals: Vec<C64> = per_symbol.iter().map(|v| v[k]).collect();
        for (l, v) in interpolation::linear(&symbols, &vals, l_n)?.into_iter().enumerate() {
            out[l * k_n + k] = v;
        }
    }
    Ok(out)
}

/// The plan of `key` in `cache`, built by `build` the first time.
fn cached<'a, K: PartialEq + Clone, P>(
    cache: &'a mut Vec<(K, P)>,
    key: &K,
    build: impl FnOnce() -> Result<P>,
) -> Result<&'a P> {
    let i = if let Some(i) = cache.iter().position(|(k, _)| k == key) {
        i
    } else {
        cache.push((key.clone(), build()?));
        cache.len() - 1
    };
    Ok(&cache[i].1)
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::ofdm::grid::PilotPattern;
    use comnum_core::rng::Rng;
    use comnum_math::cis;

    /// A random multipath channel on the grid (static), and the received grid.
    fn channel(grid: &ResourceGrid, pdp: &PowerDelayProfile, s2: f64, rng: &mut Rng) -> (Vec<C64>, Vec<C64>) {
        let taps: Vec<C64> = pdp.powers.iter().map(|p| rng.complex_gaussian() * p.sqrt()).collect();
        let hk: Vec<C64> = (0..grid.n_subcarriers)
            .map(|k| {
                pdp.delays
                    .iter()
                    .zip(&taps)
                    .map(|(d, t)| t * cis(-2.0 * std::f64::consts::PI * k as f64 * d / pdp.n_fft as f64))
                    .sum()
            })
            .collect();
        let tx = grid.map(&vec![C64::new(1.0, 0.0); grid.n_data()]).unwrap();
        let h: Vec<C64> = (0..tx.len()).map(|i| hk[i % grid.n_subcarriers]).collect();
        let rx = tx.iter().zip(&h).map(|(x, g)| x * g + rng.complex_gaussian() * s2.sqrt()).collect();
        (h, rx)
    }

    #[test]
    fn lmmse_beats_linear_interpolation_and_ls_has_the_noise_variance() {
        let grid =
            ResourceGrid { n_subcarriers: 64, n_symbols: 2, pattern: PilotPattern::Block { period: 1 }, seed: 1 };
        let pdp = PowerDelayProfile::new(vec![0.0, 2.0, 5.0], &[1.0, 0.5, 0.25], 64).unwrap();
        let mut rng = Rng::new(2);
        let s2 = 0.1;
        let (mut e_ls, mut e_mm) = (0.0, 0.0);
        for _ in 0..200 {
            let (h, rx) = channel(&grid, &pdp, s2, &mut rng);
            let a = estimate(&grid, &rx, s2, &FrequencyInterpolation::Linear).unwrap();
            let b = estimate(&grid, &rx, s2, &FrequencyInterpolation::Lmmse(pdp.clone())).unwrap();
            e_ls += a.iter().zip(&h).map(|(x, y)| (x - y).norm_sqr()).sum::<f64>() / a.len() as f64;
            e_mm += b.iter().zip(&h).map(|(x, y)| (x - y).norm_sqr()).sum::<f64>() / b.len() as f64;
        }
        // pilots everywhere: linear interpolation is LS, of MSE σ²
        assert!((e_ls / 200.0 / s2 - 1.0).abs() < 0.05);
        // three taps: LMMSE keeps about 3/64 of the noise
        assert!(e_mm / 200.0 < 0.1 * s2, "{}", e_mm / 200.0);
    }

    #[test]
    fn the_interpolators_built_once_give_the_former_estimates() {
        // the former computation: the LMMSE system and the band-limited interpolation
        // built and solved again for every pilot symbol
        let former = |grid: &ResourceGrid, rx: &[C64], s2: f64, method: &FrequencyInterpolation| {
            let k_n = grid.n_subcarriers;
            let symbols = grid.pilot_symbols();
            let per_symbol: Vec<Vec<C64>> = symbols
                .iter()
                .map(|&l| {
                    let ks = grid.port_pilots(l, 0, 1);
                    let pilots: Vec<C64> = ks.iter().map(|&k| grid.pilot(k, l)).collect();
                    let hp: Vec<C64> = ks.iter().zip(&pilots).map(|(&k, p)| rx[l * k_n + k] / p).collect();
                    match method {
                        FrequencyInterpolation::LowPass { half, alpha } => {
                            interpolation::lowpass(&ks, &hp, k_n, *half, *alpha).unwrap()
                        }
                        FrequencyInterpolation::Lmmse(pdp) => {
                            let r_pp = Array2::from_shape_fn((ks.len(), ks.len()), |(i, j)| {
                                pdp.correlation(ks[i] as f64 - ks[j] as f64)
                            });
                            let r_qp = Array2::from_shape_fn((k_n, ks.len()), |(q, j)| {
                                pdp.correlation(q as f64 - ks[j] as f64)
                            });
                            let energy = pilots.iter().map(C64::norm_sqr).sum::<f64>() / pilots.len() as f64;
                            comnum_dsp::estimation::lmmse(&r_qp, &r_pp, s2 / energy, &hp).unwrap()
                        }
                        _ => unreachable!(),
                    }
                })
                .collect();
            let mut out = vec![C64::new(0.0, 0.0); k_n * grid.n_symbols];
            for k in 0..k_n {
                let vals: Vec<C64> = per_symbol.iter().map(|v| v[k]).collect();
                for (l, v) in interpolation::linear(&symbols, &vals, grid.n_symbols).unwrap().into_iter().enumerate() {
                    out[l * k_n + k] = v;
                }
            }
            out
        };
        let pdp = PowerDelayProfile::new(vec![0.0, 2.0, 5.0], &[1.0, 0.5, 0.25], 64).unwrap();
        let mut rng = Rng::new(6);
        for pattern in [PilotPattern::Comb { spacing: 4 }, PilotPattern::Lattice { freq: 3, time: 2 }] {
            let grid = ResourceGrid { n_subcarriers: 48, n_symbols: 6, pattern, seed: 2 };
            let (_, rx) = channel(&grid, &pdp, 0.05, &mut rng);
            for method in
                [FrequencyInterpolation::Lmmse(pdp.clone()), FrequencyInterpolation::LowPass { half: 4, alpha: 0.5 }]
            {
                assert_eq!(
                    estimate(&grid, &rx, 0.05, &method).unwrap(),
                    former(&grid, &rx, 0.05, &method),
                    "{method:?}"
                );
            }
        }
    }

    #[test]
    fn boosted_pilots_lower_the_noise_of_the_estimates() {
        use crate::ofdm::grid::PilotTable;
        // pilots on every RE, of amplitude 2: the LS estimate Y / X has the variance σ² / 4
        let boosted = |a: f64| {
            let t = PilotTable::new(64, 2, (0..2).flat_map(|l| (0..64).map(move |k| ((k, l), C64::new(a, 0.0)))));
            ResourceGrid::from_table(t.unwrap())
        };
        let pdp = PowerDelayProfile::new(vec![0.0, 2.0, 5.0], &[1.0, 0.5, 0.25], 64).unwrap();
        let mut rng = Rng::new(3);
        let s2 = 0.1;
        let mut mse = [[0.0; 2]; 2];
        for (i, a) in [1.0, 2.0].into_iter().enumerate() {
            let grid = boosted(a);
            for _ in 0..200 {
                let (h, rx) = channel(&grid, &pdp, s2, &mut rng);
                let ls = estimate(&grid, &rx, s2, &FrequencyInterpolation::Linear).unwrap();
                let mm = estimate(&grid, &rx, s2, &FrequencyInterpolation::Lmmse(pdp.clone())).unwrap();
                mse[i][0] += ls.iter().zip(&h).map(|(x, y)| (x - y).norm_sqr()).sum::<f64>() / ls.len() as f64 / 200.0;
                mse[i][1] += mm.iter().zip(&h).map(|(x, y)| (x - y).norm_sqr()).sum::<f64>() / mm.len() as f64 / 200.0;
            }
        }
        assert!((mse[0][0] / s2 - 1.0).abs() < 0.05, "{mse:?}");
        assert!((mse[1][0] / (s2 / 4.0) - 1.0).abs() < 0.05, "{mse:?}");
        // LMMSE weighs the boosted estimates with their own noise: about 4 times less error
        assert!((mse[0][1] / mse[1][1] / 4.0 - 1.0).abs() < 0.15, "{mse:?}");
    }
}