numkit-doxy/dpcmopt_8hpp_source.html

// toolboxes/comm/include/nk/comm/source/dpcmopt.hpp

//

// DPCM parameter optimiser.


#pragma once


#include <memory_resource>

#include <nk/value/value.hpp>


namespace nk::comm {


struct DpcmOptResult {

    Value predictor;

    Value codebook;

    Value partition;

};


DpcmOptResult

dpcmopt(const Value &training_set, int ord,

        const Value &ini_codebook = Value::Empty,

        std::pmr::memory_resource *mr = nullptr);


} // namespace nk::comm

nk::Value
Core MATLAB-compatible multidimensional array and scalar value type.
Definition value.hpp:61

nk::Value::Empty
static const Value Empty
MATLAB-style empty matrix sentinel — a 0×0 DOUBLE value.
Definition value.hpp:136

nk::comm::dpcmopt
DpcmOptResult dpcmopt(const Value &training_set, int ord, const Value &ini_codebook=Value::Empty, std::pmr::memory_resource *mr=nullptr)
Optimise DPCM predictor + (optional) quantizer ([predictor, codebook, partition] = dpcmopt(training,...

nk::comm::DpcmOptResult
Result of dpcmopt.
Definition dpcmopt.hpp:19

nk::comm::DpcmOptResult::predictor
Value predictor
Length-(ord+1) row vector [0, p1, …, pM].
Definition dpcmopt.hpp:20

nk::comm::DpcmOptResult::partition
Value partition
Optional partition — empty unless requested.
Definition dpcmopt.hpp:22

nk::comm::DpcmOptResult::codebook
Value codebook
Optional codebook — empty unless requested.
Definition dpcmopt.hpp:21