nr-pm-search.h

// Copyright (c) 2024 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
//
// SPDX-License-Identifier: GPL-2.0-only
 
#ifndef NR_PM_SEARCH_H
#define NR_PM_SEARCH_H
 
#include "nr-amc.h"
#include "nr-mimo-chunk-processor.h"
#include "nr-mimo-signal.h"
 
#include "ns3/random-variable-stream.h"
#include "ns3/uinteger.h"
 
namespace ns3
{
 
class NrPmSearch : public Object
{
  public:
    static TypeId GetTypeId();
 
    NrPmSearch();
 
    void SetAmc(Ptr<const NrAmc> amc);
 
    void SetGnbParams(bool isDualPol, size_t numHPorts, size_t numVPorts);
 
    void SetUeParams(size_t numTotalPorts);
 
    void SetSubbandSize(size_t subbandSize);
 
    size_t GetSubbandSize() const;
 
    virtual void InitCodebooks() = 0;
 
    struct PmiUpdate
    {
        PmiUpdate() = default;
 
        PmiUpdate(bool uWb, bool uSb)
        {
            updateWb = uWb;
            updateSb = uSb;
        }
 
        bool updateWb{false}; 
        bool updateSb{false}; 
    };
 
    virtual PmCqiInfo CreateCqiFeedbackMimo(const NrMimoSignal& rxSignalRb,
                                            PmiUpdate pmiUpdate) = 0;
 
    virtual NrIntfNormChanMat SubbandDownsampling(const NrIntfNormChanMat& channelMatrix);
 
    virtual NrIntfNormChanMat SubbandUpsampling(const NrIntfNormChanMat& precMat,
                                                size_t numPrbs) const;
 
    enum DownsamplingTechnique
    {
        FirstPRB,   
        RandomPRB,  
        AveragePRB, 
    };
 
    int64_t AssignStreams(int64_t stream);
 
    virtual uint8_t SelectRank(NrIntfNormChanMat& channelMatrix) const;
 
    enum RankTechnique
    {
        SVD,          
        WaterFilling, 
        Sasaoka       
    };
 
  protected:
    struct PrecMatParams : public SimpleRefCount<PrecMatParams>
    {
        size_t wbPmi{};                 
        std::vector<size_t> sbPmis{};   
        ComplexMatrixArray sbPrecMat{}; 
        double perfMetric{}; 
    };
 
    size_t m_subbandSize{1};   
    bool m_enforceSubbandSize; 
    bool m_subbandCqiClamping; 
    enum DownsamplingTechnique m_downsamplingTechnique; 
    Ptr<UniformRandomVariable>
        m_downsamplingUniRand; 
 
    bool m_isGnbDualPol{false}; 
    size_t m_nGnbHPorts{0};     
    size_t m_nGnbVPorts{0};     
    size_t m_nGnbPorts{0};      
    size_t m_nRxPorts{0};       
 
    Ptr<const NrAmc> m_amc{nullptr}; 
 
    uint8_t m_rankLimit{UINT8_MAX}; 
    std::vector<uint8_t> m_ranks{}; 
  private:
    size_t GetNumSubbands(const NrIntfNormChanMat& chanMat) const;
 
    void GetSubbandDownsampleFirstPrb(const NrIntfNormChanMat& chanMat,
                                      ComplexMatrixArray& downsampledChanMat) const;
    void GetSubbandDownsampleRandomPrb(const NrIntfNormChanMat& chanMat,
                                       ComplexMatrixArray& downsampledChanMat) const;
 
    void GetSubbandDownsampleAveragePrb(const NrIntfNormChanMat& chanMat,
                                        ComplexMatrixArray& downsampledChanMat) const;
 
    double m_rankThreshold;                 
    RankTechnique m_rankTechnique{Sasaoka}; 
};
 
} // namespace ns3
 
#endif // NR_PM_SEARCH_H