Searching...

No Matches

An implementation of NrPmSearch that uses exhaustive search for 3GPP Type-I codebooks. This class creates a CQI/PMI/RI feedback message by looping over all ranks and selecting the rank that results in the largest achievable TB size. When a PMI update is requested, the optimal precoding matrices (PMI) are updated using exhaustive search over all possible precoding matrices specified in a codebook that is compatible to 3GPP TS 38.214 Type-I. More...

#include "nr-pm-search-full.h"

Inheritance diagram for ns3::NrPmSearchFull:

Collaboration diagram for ns3::NrPmSearchFull:

Classes
struct	RankParams

Public Member Functions
PmCqiInfo	CreateCqiFeedbackMimo (const NrMimoSignal &rxSignalRb, PmiUpdate pmiUpdate) override
	Create CQI feedback with optimal rank, optimal PMI, and corresponding CQI values. Optimal rank is considered as the rank that maximizes the achievable TB size when using the optimal PMI. The optimal WB/SB PMI values are updated based on pmiUpdate. If there is no update to the PMI values, the previously found PMI values are used.

void	InitCodebooks () override
	Create and initialize the codebook for each rank.

void	SetCodebookAttribute (const std::string &attrName, const AttributeValue &attrVal)
	Set the ns-3 attribute of the codebook (NrCbTypeOne).

void	SetCodebookTypeId (const TypeId &typeId)
	Set the TypeId of the codebook (NrCbTypeOne) to be used.

Public Member Functions inherited from ns3::NrPmSearch
	NrPmSearch ()
	Default constructor.

int64_t	AssignStreams (int64_t stream)

size_t	GetSubbandSize () const

virtual uint8_t	SelectRank (NrIntfNormChanMat &channelMatrix) const
	Select the MIMO rank for a given channel matrix.

void	SetAmc (Ptr< const NrAmc > amc)
	Set the AMC object to be used for MCS and TB size calculation.

void	SetGnbParams (bool isDualPol, size_t numHPorts, size_t numVPorts)
	Set the antenna parameters of the gNB antenna.

void	SetSubbandSize (size_t subbandSize)
	Set the subband size (in number of RBs)

void	SetUeParams (size_t numTotalPorts)
	Set the antenna parameters of the UE antenna.

virtual NrIntfNormChanMat	SubbandDownsampling (const NrIntfNormChanMat &channelMatrix)
	Downsample the input channel matrix into bins of at most m_subbandSize PRBs.

virtual NrIntfNormChanMat	SubbandUpsampling (const NrIntfNormChanMat &precMat, size_t numPrbs) const
	Upsample the input per-subband precoding matrix into a per-PRB precoding matrix.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get TypeId.

Static Public Member Functions inherited from ns3::NrPmSearch
static TypeId	GetTypeId ()
	Get TypeId.

Protected Member Functions
DoubleMatrixArray	ComputeCapacityForPrecoders (const NrIntfNormChanMat &sbNormChanMat, std::vector< ComplexMatrixArray > allPrecMats) const
	Compute the Shannon capacity for each possible precoding matrix in each subband.

void	ConditionallyUpdatePrecoding (const NrIntfNormChanMat &rbNormChanMat, PmiUpdate pmiUpdate)
	Update the WB and/or SB PMI, or neither.

PmCqiInfo	CreateCqiForRank (uint8_t rank, const NrIntfNormChanMat &rbNormChanMat) const
	Create CQI feedback message for a particular rank.

std::vector< ComplexMatrixArray >	CreateSubbandPrecoders (size_t i1, uint8_t rank, size_t nSubbands) const
	Create the subband precoding matrices for the given wideband precoding.

virtual Ptr< PrecMatParams >	FindOptSubbandPrecoding (const NrIntfNormChanMat &sbNormChanMat, size_t i1, uint8_t rank) const
	Find the optimal subband precoding matrix for the given wideband precoding.

void	UpdateAllPrecoding (const NrIntfNormChanMat &rbNormChanMat)
	For all ranks, update the optimum precoding matrices (wideband and subband).

void	UpdateSubbandPrecoding (const NrIntfNormChanMat &rbNormChanMat)
	For all ranks, update the opt subband PMI assuming previous value of wideband PMI.

Static Protected Member Functions
static ComplexMatrixArray	ExpandPrecodingMatrix (ComplexMatrixArray basePrecMat, size_t nSubbands)

Protected Attributes
ObjectFactory	m_cbFactory
	The factory used to create the codebooks.

std::vector< RankParams >	m_rankParams
	The parameters (PMI values, codebook) for each rank.

Protected Attributes inherited from ns3::NrPmSearch
Ptr< const NrAmc >	m_amc {nullptr}
	The NrAmc to be used for computing TB size and MCS.

enum DownsamplingTechnique	m_downsamplingTechnique
	Technique used to downsample PRBs.

Ptr< UniformRandomVariable >	m_downsamplingUniRand
	Uniform variable stream used to downsample PRBs.

bool	m_isGnbDualPol {false}
	True when gNB has a dual-polarized antenna array.

size_t	m_nGnbHPorts {0}
	Number of horizontal ports in the gNB antenna array.

size_t	m_nGnbPorts {0}
	Total number of ports in the gNB antenna array.

size_t	m_nGnbVPorts {0}
	Number of vertical ports in the gNB antenna array.

size_t	m_nRxPorts {0}
	Number of receive ports at this UE.

uint8_t	m_rankLimit {UINT8_MAX}
	Limit the UE's maximum supported rank.

std::vector< uint8_t >	m_ranks {}
	The set of ranks for which to compute precoding matrices.

bool	m_subbandCqiClamping

size_t	m_subbandSize {1}
	Size of each subband (in number of RBs)

Additional Inherited Members
Public Types inherited from ns3::NrPmSearch
enum	DownsamplingTechnique { FirstPRB , RandomPRB , AveragePRB }

enum	RankTechnique { SVD , WaterFilling , Sasaoka }

Detailed Description

Introspection did not find any typical Config paths.

Attributes

CodebookType: Codebook class to be used
- Set with class: ns3::TypeIdValue
- Underlying type: TypeId
- Initial value: ns3::NrCbTwoPort
- Flags: construct write

Attributes defined in parent class ns3::NrPmSearch

RankLimit: Max MIMO rank is minimum of num UE ports, num gNB ports, and RankLimit
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 1:255
- Initial value: 255
- Flags: construct write read
RankTechnique: Technique used to determine the MIMO Rank
- Set with class: ns3::EnumValue<N3ns310NrPmSearch13RankTechniqueE>
- Underlying type: SVD|WaterFilling|Sasaoka
- Initial value: SVD
- Flags: construct write read
RankThreshold: Rank threshold for SVD selection
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 2.22045e-16
- Flags: construct write read
SubbandSize: Size of subband in PRBs for downsampling
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 1:32
- Initial value: 1
- Flags: construct write read
DownsamplingTechnique: Algorithm used to downsample PRBs into SBs
- Set with class: ns3::EnumValue<N3ns310NrPmSearch21DownsamplingTechniqueE>
- Underlying type: FirstPRB|RandomPRB|AveragePRB
- Initial value: FirstPRB
- Flags: construct write read
SubbandCqiClamping: Clamp sub-band CQI range to wideband CQI [-1,+2], according to 3GPP 2-bit information overhead limit
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: construct write read

No TraceSources are defined for this type.
Size of this type is 232 bytes (on a 64-bit architecture).

Definition at line 23 of file nr-pm-search-full.h.

Member Function Documentation

◆ ComputeCapacityForPrecoders()

DoubleMatrixArray ns3::NrPmSearchFull::ComputeCapacityForPrecoders	(	const NrIntfNormChanMat &	sbNormChanMat,
		std::vector< ComplexMatrixArray >	allPrecMats
	)		const

protected

Compute the Shannon capacity for each possible precoding matrix in each subband.

Parameters

sbNormChanMat	the interference-normed channel matrix per subband
allPrecMats	a vector of all possible subband precoding matrices for fixed i1 and rank

Returns: a matrix with the capacity values (nSubbands x allPrecMats.size())

Definition at line 297 of file nr-pm-search-full.cc.

References ns3::NrIntfNormChanMat::ComputeSinrForPrecoding().

Referenced by ns3::NrPmSearchMaleki::CreateCqiFeedbackMimo(), FindOptSubbandPrecoding(), and ns3::NrPmSearchFast::GetWidebandI1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ConditionallyUpdatePrecoding()

void ns3::NrPmSearchFull::ConditionallyUpdatePrecoding	(	const NrIntfNormChanMat &	rbNormChanMat,
		PmiUpdate	pmiUpdate
	)

protected

Update the WB and/or SB PMI, or neither.

Parameters

rbNormChanMat	the interference-normed channel matrix per RB
pmiUpdate	the struct defining if updates to SB or WB PMI are necessary

Definition at line 108 of file nr-pm-search-full.cc.

References UpdateAllPrecoding(), ns3::NrPmSearch::PmiUpdate::updateSb, UpdateSubbandPrecoding(), and ns3::NrPmSearch::PmiUpdate::updateWb.

Referenced by CreateCqiFeedbackMimo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CreateCqiFeedbackMimo()

PmCqiInfo ns3::NrPmSearchFull::CreateCqiFeedbackMimo	(	const NrMimoSignal &	rxSignalRb,
		PmiUpdate	pmiUpdate
	)

overridevirtual

Create CQI feedback with optimal rank, optimal PMI, and corresponding CQI values. Optimal rank is considered as the rank that maximizes the achievable TB size when using the optimal PMI. The optimal WB/SB PMI values are updated based on pmiUpdate. If there is no update to the PMI values, the previously found PMI values are used.

Parameters

rxSignalRb	the receive signal parameters (channel and interference matrices)
pmiUpdate	struct that defines if WB/SB PMIs need to be updated

Returns: the CQI feedback message that contains the optimum CQI, RI, PMI, and full precoding matrix (dimensions: nGnbPorts * rank * nRbs)

Implements ns3::NrPmSearch.

Reimplemented in ns3::NrPmSearchIdeal, ns3::NrPmSearchMaleki, and ns3::NrPmSearchSasaoka.

Definition at line 66 of file nr-pm-search-full.cc.

References ns3::NrCovMat::CalcIntfNormChannel(), ConditionallyUpdatePrecoding(), CreateCqiForRank(), ns3::NrMimoSignal::m_chanMat, ns3::NrMimoSignal::m_covMat, ns3::NrPmSearch::m_nGnbPorts, ns3::NrPmSearch::m_nRxPorts, and ns3::NrPmSearch::m_ranks.

Here is the call graph for this function:

◆ CreateCqiForRank()

PmCqiInfo ns3::NrPmSearchFull::CreateCqiForRank	(	uint8_t	rank,
		const NrIntfNormChanMat &	rbNormChanMat
	)		const

protected

Create CQI feedback message for a particular rank.

Parameters

rank	the rank for which to create the CQI feedback
rbNormChanMat	the interference-normed channel matrix per RB

Returns: the CQI message with PMI and CQI values, as well as expected TB size

Definition at line 167 of file nr-pm-search-full.cc.

References ns3::NrIntfNormChanMat::ComputeSinrForPrecoding(), ns3::NrPmSearch::m_amc, ns3::PmCqiInfo::m_mcs, m_rankParams, ns3::NrPmSearch::m_subbandCqiClamping, ns3::NrPmSearch::m_subbandSize, and ns3::NrPmSearch::SubbandUpsampling().

Referenced by ns3::NrPmSearchFast::CreateCqiFeedbackMimo(), CreateCqiFeedbackMimo(), ns3::NrPmSearchIdeal::CreateCqiFeedbackMimo(), ns3::NrPmSearchMaleki::CreateCqiFeedbackMimo(), and ns3::NrPmSearchSasaoka::CreateCqiFeedbackMimo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CreateSubbandPrecoders()

std::vector< ComplexMatrixArray > ns3::NrPmSearchFull::CreateSubbandPrecoders	(	size_t	i1,
		uint8_t	rank,
		size_t	nSubbands
	)		const

protected

Create the subband precoding matrices for the given wideband precoding.

Parameters

i1	the index of the wideband precoding matrix W1
rank	the rank (number of MIMO layers)
nSubbands	the number of subbands (desired number of pages in each precoding matrix)

Returns: a vector of all possible precoding matrices for fixed i1 and rank

Definition at line 260 of file nr-pm-search-full.cc.

References m_rankParams.

Referenced by FindOptSubbandPrecoding().

Here is the caller graph for this function:

◆ ExpandPrecodingMatrix()

ComplexMatrixArray ns3::NrPmSearchFull::ExpandPrecodingMatrix	(	ComplexMatrixArray	basePrecMat,
		size_t	nSubbands
	)

staticprotected

Definition at line 277 of file nr-pm-search-full.cc.

◆ FindOptSubbandPrecoding()

Ptr< NrPmSearchFull::PrecMatParams > ns3::NrPmSearchFull::FindOptSubbandPrecoding	(	const NrIntfNormChanMat &	sbNormChanMat,
		size_t	i1,
		uint8_t	rank
	)		const