nr-eesm-error-model.h

// Copyright (c) 2018 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
//
// SPDX-License-Identifier: GPL-2.0-only
 
#ifndef NR_EESM_ERROR_MODEL_H
#define NR_EESM_ERROR_MODEL_H
 
#include "nr-error-model.h"
 
#include <map>
 
namespace ns3
{
 
class NrL2smEesmTestCase;
 
struct NrEesmErrorModelOutput : public NrErrorModelOutput
{
    NrEesmErrorModelOutput() = delete;
 
    NrEesmErrorModelOutput(double tbler)
        : NrErrorModelOutput(tbler)
    {
    }
 
    double m_sinrExp{0.0};  
    double m_sinrEff{0.0};  
    SpectrumValue m_sinr;   
    std::vector<int> m_map; 
    uint32_t m_infoBits{0}; 
    uint32_t m_codeBits{0}; 
};
 
class NrEesmErrorModel : public NrErrorModel
{
  public:
    friend NrL2smEesmTestCase;
    static TypeId GetTypeId();
 
    NrEesmErrorModel();
    ~NrEesmErrorModel() override;
 
    Ptr<NrErrorModelOutput> GetTbDecodificationStats(
        const SpectrumValue& sinr,
        const std::vector<int>& map,
        uint32_t size,
        uint8_t mcs,
        const NrErrorModelHistory& sinrHistory) override;
 
    double GetSpectralEfficiencyForCqi(uint8_t cqi) override;
    double GetSpectralEfficiencyForMcs(uint8_t mcs) const override;
    uint32_t GetPayloadSize(uint32_t usefulSc,
                            uint8_t mcs,
                            uint8_t rank,
                            uint32_t rbNum,
                            Mode mode) const override;
    uint32_t GetMaxCbSize(uint32_t tbSize, uint8_t mcs) const override;
    uint8_t GetMaxMcs() const override;
 
    typedef std::vector<double> DoubleVector;
    typedef std::tuple<DoubleVector, DoubleVector> DoubleTuple;
    typedef std::vector<std::vector<std::map<uint32_t, DoubleTuple>>> SimulatedBlerFromSINR;
 
  protected:
    std::string PrintMap(const std::vector<int>& map) const;
 
    double SinrEff(const SpectrumValue& sinr,
                   const std::vector<int>& map,
                   uint8_t mcs,
                   double a,
                   double b) const;
 
    double SinrExp(const SpectrumValue& sinr, const std::vector<int>& map, uint8_t mcs) const;
 
    virtual double ComputeSINR(const SpectrumValue& sinr,
                               const std::vector<int>& map,
                               uint8_t mcs,
                               uint32_t sizeBit,
                               const NrErrorModel::NrErrorModelHistory& sinrHistory) const = 0;
 
    virtual double GetMcsEq(uint8_t mcsTx) const = 0;
 
    virtual const std::vector<double>* GetBetaTable() const = 0;
    virtual const std::vector<double>* GetMcsEcrTable() const = 0;
    virtual const SimulatedBlerFromSINR* GetSimulatedBlerFromSINR() const = 0;
    virtual const std::vector<uint8_t>* GetMcsMTable() const = 0;
    virtual const std::vector<double>* GetSpectralEfficiencyForMcs() const = 0;
    virtual const std::vector<double>* GetSpectralEfficiencyForCqi() const = 0;
 
  private:
    static std::vector<std::string> m_bgTypeName; 
 
    double MappingSinrBler(double sinrEff, uint8_t mcs, uint32_t cbSize);
 
    Ptr<NrErrorModelOutput> GetTbBitDecodificationStats(const SpectrumValue& sinr,
                                                        const std::vector<int>& map,
                                                        uint32_t size,
                                                        uint8_t mcs,
                                                        const NrErrorModelHistory& sinrHistory);
 
    enum GraphType
    {
        FIRST = 0, 
        SECOND = 1 
    };
 
    GraphType GetBaseGraphType(uint32_t tbSize, uint8_t mcs) const;
 
    std::pair<uint32_t, uint32_t> CodeBlockSegmentation(uint32_t B, GraphType bg_type) const;
 
    const std::vector<double>& GetSinrDbVectorFromSimulatedValues(GraphType graphType,
                                                                  uint8_t mcs,
                                                                  uint32_t cbSizeIndex) const;
    const std::vector<double>& GetBLERVectorFromSimulatedValues(GraphType graphType,
                                                                uint8_t mcs,
                                                                uint32_t cbSizeIndex) const;
};
 
} // namespace ns3
 
#endif /* NR_EESM_ERROR_MODEL_H */