5G-LENA: ns3::NrEesmIr Class Reference

Searching...

No Matches

Eesm error model, based on the IR HARQ. More...

#include "nr-eesm-ir.h"

Inheritance diagram for ns3::NrEesmIr:

Collaboration diagram for ns3::NrEesmIr:

Public Member Functions
	NrEesmIr ()
	NrEesmIr constructor.

	~NrEesmIr () override
	~NrEesmIr deconstructor

Public Member Functions inherited from ns3::NrEesmErrorModel
	NrEesmErrorModel ()
	NrEesmErrorModel constructor.

	~NrEesmErrorModel () override
	~NrEesmErrorModel

uint32_t	GetMaxCbSize (uint32_t tbSize, uint8_t mcs) const override
	Get the maximum code block size in Bytes, as per NR. It depends on the LDPC base graph type.

uint8_t	GetMaxMcs () const override
	Get the maximum MCS. It depends on NR tables being used.

uint32_t	GetPayloadSize (uint32_t usefulSc, uint8_t mcs, uint8_t rank, uint32_t rbNum, Mode mode) const override
	Get the payload size in Bytes, following the MCSs in NR. It follows TS 38.214 Section 5.1.3.2 (DL) and 6.1.4.2 (UL) but without including quantizations and and limits (i.e., only up to Step 2)

double	GetSpectralEfficiencyForCqi (uint8_t cqi) override
	Get the SE for a given CQI, following the CQIs in NR Table1/Table2 in TS38.214.

double	GetSpectralEfficiencyForMcs (uint8_t mcs) const override
	Get the SE for a given MCS, following the MCSs in NR Table1/Table2 in TS38.214.

Ptr< NrErrorModelOutput >	GetTbDecodificationStats (const SpectrumValue &sinr, const std::vector< int > &map, uint32_t size, uint8_t mcs, const NrErrorModelHistory &sinrHistory) override
	Get an output for the decodification error probability of a given transport block, assuming the EESM method, NR LDPC coding and block segmentation, MCSs Table1/Table2 in NR, and HARQ based on CC.

Public Member Functions inherited from ns3::NrErrorModel
	NrErrorModel ()
	NrErrorModel default constructor.

	~NrErrorModel () override
	deconstructor

virtual NrSinrMatrix	ComputeAvgSinrMimo (const std::vector< MimoSinrChunk > &sinrChunks)
	Compute an average SINR matrix.

std::vector< int >	CreateVectorizedRbMap (std::vector< int > map, uint8_t rank)
	Create an equivalent RB index map for vectorized SINR values Matches layer-to-codeword mapping in TR 38.211, Table 7.3.1.3-1 If map contains index "j", the output vectorized map contains {j * rank, j * rank + 1, ..., j * rank + rank - 1}. Example: input RB map = {0, 1, 7, 11}, rank = 2 vectorizedMap = {0, 1, 2, 3, 14, 15, 22, 23}.

virtual Ptr< NrErrorModelOutput >	GetTbDecodificationStatsMimo (const std::vector< MimoSinrChunk > &mimoChunks, const std::vector< int > &map, uint32_t size, uint8_t mcs, uint8_t rank, const NrErrorModelHistory &history)
	Get an output for the decoding error probability of a given transport block. This method is not purely virtual. If derived ErrorModel does not override, the MIMO matrix is converted to a linear SpectrumValue, and the non-MIMO method is called.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type id of the object.

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

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

Protected Member Functions
double	ComputeSINR (const SpectrumValue &sinr, const std::vector< int > &map, uint8_t mcs, uint32_t sizeBit, const NrErrorModel::NrErrorModelHistory &sinrHistory) const override
	Computes the effective SINR after retransmission combining with HARQ-IR. Also, it updates the equivalent ECR after retransmissions (m_Reff).

double	GetMcsEq (uint8_t mcsTx) const override
	Returns the MCS corresponding to the ECR after retransmissions. In case of HARQ-IR the equivalent ECR changes after retransmissions, and it is updated inside ComputeSINR function. GetMcsEq gets the closest ECR to m_Reff from the available ones that belong to the same modulation order.

Protected Member Functions inherited from ns3::NrEesmErrorModel
virtual const std::vector< double > *	GetBetaTable () const =0

virtual const std::vector< double > *	GetMcsEcrTable () const =0

virtual const std::vector< uint8_t > *	GetMcsMTable () const =0

virtual const SimulatedBlerFromSINR *	GetSimulatedBlerFromSINR () const =0

virtual const std::vector< double > *	GetSpectralEfficiencyForCqi () const =0

virtual const std::vector< double > *	GetSpectralEfficiencyForMcs () const =0

std::string	PrintMap (const std::vector< int > &map) const
	function to print the RB map

double	SinrEff (const SpectrumValue &sinr, const std::vector< int > &map, uint8_t mcs, double a, double b) const
	compute the effective SINR for the specified MCS and SINR, according to the EESM method.

double	SinrExp (const SpectrumValue &sinr, const std::vector< int > &map, uint8_t mcs) const
	compute the sum of exponential SINRs for the specified MCS and SINR, according to the EESM method, used in HARQ-IR

Additional Inherited Members
Public Types inherited from ns3::NrEesmErrorModel
typedef std::tuple< DoubleVector, DoubleVector >	DoubleTuple

typedef std::vector< double >	DoubleVector

typedef std::vector< std::vector< std::map< uint32_t, DoubleTuple > > >	SimulatedBlerFromSINR

Public Types inherited from ns3::NrErrorModel
enum	Mode { DL , UL }
	Indicate the mode (UL or DL) More...

typedef std::vector< Ptr< NrErrorModelOutput > >	NrErrorModelHistory
	Vector of previous output.

Public Attributes inherited from ns3::NrEesmErrorModel
friend	NrL2smEesmTestCase

Detailed Description

Eesm error model, based on the IR HARQ.

In HARQ-IR, every retransmission contains different coded bits than the previous one. The different retransmissions typically use a different set of coding bits. Therefore, both the effective SINR and the equivalent ECR need to be recomputed after each retransmission.

In HARQ-IR, the HARQ history contains the last computed effective SINR and number of coded bits of each of the previous retransmissions. Given the current SINR vector and the HARQ history, the effective SINR is computed according to EESM.

NOTE: The method GetMcsEq() must be called after ComputeSINR(), as it uses the value m_Reff.

Please, don't use this class directly, but one between NrEesmIrT1 or NrEesmIrT2, depending on what table you want to use.

Introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 64 bytes (on a 64-bit architecture).

Definition at line 33 of file nr-eesm-ir.h.

Constructor & Destructor Documentation

◆ NrEesmIr()

ns3::NrEesmIr::NrEesmIr ( )

NrEesmIr constructor.

Definition at line 15 of file nr-eesm-ir.cc.

◆ ~NrEesmIr()

ns3::NrEesmIr::~NrEesmIr ( )

override

~NrEesmIr deconstructor

Definition at line 20 of file nr-eesm-ir.cc.

Member Function Documentation

◆ ComputeSINR()

double ns3::NrEesmIr::ComputeSINR	(	const SpectrumValue &	sinr,
		const std::vector< int > &	map,
		uint8_t	mcs,
		uint32_t	sizeBit,
		const NrErrorModel::NrErrorModelHistory &	sinrHistory
	)		const

overrideprotectedvirtual

Computes the effective SINR after retransmission combining with HARQ-IR. Also, it updates the equivalent ECR after retransmissions (m_Reff).

Parameters

sinr	the SINR vector of current transmission
map	the RB map of current transmission
sizeBit	the Transport block size in bits
mcs	the MCS
sinrHistory	the History of the previous transmissions of the same block

Returns: The effective SINR

Implements ns3::NrEesmErrorModel.

Definition at line 33 of file nr-eesm-ir.cc.

References ns3::NrEesmErrorModel::GetMcsEcrTable(), and ns3::NrEesmErrorModel::SinrEff().

Here is the call graph for this function:

◆ GetMcsEq()

double ns3::NrEesmIr::GetMcsEq ( uint8_t mcsTx ) const

overrideprotectedvirtual

Returns the MCS corresponding to the ECR after retransmissions. In case of HARQ-IR the equivalent ECR changes after retransmissions, and it is updated inside ComputeSINR function. GetMcsEq gets the closest ECR to m_Reff from the available ones that belong to the same modulation order.

Parameters

mcsTx the MCS of the transmission

Returns: The equivalent MCS after retransmissions

Implements ns3::NrEesmErrorModel.

Definition at line 74 of file nr-eesm-ir.cc.

References ns3::NrEesmErrorModel::GetMcsEcrTable(), and ns3::NrEesmErrorModel::GetMcsMTable().

Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::NrEesmIr::GetTypeId ( )

static

Get the type id of the object.

Returns: the type id of the object

Definition at line 26 of file nr-eesm-ir.cc.

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members