signal_modeling.hpp

Go to the documentation of this file.

// toolboxes/signal/include/nk/signal/spectral_analysis/signal_modeling.hpp
//
// Parametric signal modelling: Yule-Walker / Burg / linear-prediction
// AR models + the conversion utilities that move between AR poly,
// reflection coefficients, autocorrelation, line-spectral frequencies,
// inverse-sine and log-area-ratio representations.
 
#pragma once
 
#include <memory_resource>
#include <nk/value/value.hpp>
 
#include <tuple>
 
namespace nk::signal {

 
 
// ─────────────────────────────────────────────────────────────────────
// Foundation: Levinson-Durbin
// ─────────────────────────────────────────────────────────────────────

std::tuple<Value, Value, Value>
levinson(const Value &                r,
         int                          n  = -1,
         std::pmr::memory_resource *  mr = nullptr);

std::tuple<Value, Value>
rlevinson(const Value &                a,
          double                       efinal,
          std::pmr::memory_resource *  mr = nullptr);
 
// ─────────────────────────────────────────────────────────────────────
// Autoregressive estimation
// ─────────────────────────────────────────────────────────────────────

std::tuple<Value, Value, Value>
aryule(const Value &                x,
       int                          p,
       std::pmr::memory_resource *  mr = nullptr);

std::tuple<Value, Value, Value>
arburg(const Value &x, int p,
       std::pmr::memory_resource *mr = nullptr);

std::tuple<Value, Value>
lpc(const Value &                x,
    int                          p,
    std::pmr::memory_resource *  mr = nullptr);
 
// ─────────────────────────────────────────────────────────────────────
// Representation conversions (poly ↔ rc ↔ autocorr)
// ─────────────────────────────────────────────────────────────────────

std::tuple<Value, Value>
ac2poly(const Value &                R,
        std::pmr::memory_resource *  mr = nullptr);

Value poly2ac(const Value &                a,
              double                       e,
              std::pmr::memory_resource *  mr = nullptr);

std::tuple<Value, Value>
ac2rc(const Value &                R,
      std::pmr::memory_resource *  mr = nullptr);

Value schurrc(const Value &                R,
              std::pmr::memory_resource *  mr = nullptr);

Value rc2ac(const Value &k, double r0,
            std::pmr::memory_resource *mr = nullptr);

std::tuple<Value, Value>
poly2rc(const Value &                a,
        double                       efinal = 0.0,
        std::pmr::memory_resource *  mr     = nullptr);

std::tuple<Value, Value>
rc2poly(const Value &                k,
        double                       r0 = 1.0,
        std::pmr::memory_resource *  mr = nullptr);

Value is2rc(const Value &                is,
            std::pmr::memory_resource *  mr = nullptr);

Value rc2is(const Value &                k,
            std::pmr::memory_resource *  mr = nullptr);

Value lar2rc(const Value &                g,
             std::pmr::memory_resource *  mr = nullptr);

Value rc2lar(const Value &                k,
             std::pmr::memory_resource *  mr = nullptr);
 
// ─────────────────────────────────────────────────────────────────────
// Covariance / modified-covariance AR + Prony + corrmtx
// ─────────────────────────────────────────────────────────────────────

std::tuple<Value, Value>
arcov(const Value &                x,
      int                          p,
      std::pmr::memory_resource *  mr = nullptr);

std::tuple<Value, Value>
armcov(const Value &x, int p,
       std::pmr::memory_resource *mr = nullptr);

std::tuple<Value, Value>
prony(const Value &                h,
      int                          nb,
      int                          na,
      std::pmr::memory_resource *  mr = nullptr);

std::tuple<Value, Value>
stmcb(const Value &                h,
      int                          nb,
      int                          na,
      int                          niter = 5,
      std::pmr::memory_resource *  mr = nullptr);

Value corrmtx(const Value &                x,
              int                          m,
              std::pmr::memory_resource *  mr = nullptr);

std::tuple<Value, Value>
pmusic(const Value &                x,
       int                          p,
       int                          nfft = 256,
       double                       fs   = 2.0 * 3.14159265358979323846,
       std::pmr::memory_resource *  mr   = nullptr);

std::tuple<Value, Value>
peig(const Value &                x,
     int                          p,
     int                          nfft = 256,
     double                       fs   = 2.0 * 3.14159265358979323846,
     std::pmr::memory_resource *  mr   = nullptr);
 
// ─────────────────────────────────────────────────────────────────────
// LSF ↔ AR poly
// ─────────────────────────────────────────────────────────────────────

Value poly2lsf(const Value &                a,
               std::pmr::memory_resource *  mr = nullptr);

Value lsf2poly(const Value &                lsf,
               std::pmr::memory_resource *  mr = nullptr);
 
// ─────────────────────────────────────────────────────────────────────
// invfreqs / invfreqz — frequency-response least-squares fit
// ─────────────────────────────────────────────────────────────────────

std::tuple<Value, Value>
invfreqs(const Value &                H,
         const Value &                w,
         int                          nb,
         int                          na,
         std::pmr::memory_resource *  mr = nullptr);

std::tuple<Value, Value>
invfreqz(const Value &H, const Value &w, int nb, int na,
         std::pmr::memory_resource *mr = nullptr);
 

} // namespace nk::signal