# mu-mimo/mu_mimo/types.py
from dataclasses import dataclass, field
import numpy as np
from numpy.typing import NDArray
from typing import Literal
RealArray = NDArray[np.floating]
ComplexArray = NDArray[np.complexfloating]
IntArray = NDArray[np.integer]
BitArray = NDArray[np.integer]
ConstType = Literal["PAM", "PSK", "QAM"]
[docs]
@dataclass()
class ChannelState:
"""
The state of the channel.
Parameters
----------
snr : float
The signal-to-noise ratio.
H : ComplexArray, shape (K * Nr, Nt)
The channel matrix.
Notes
-----
How does the channel state differ from the channel state information (CSI)?
The channel state contains the actual channel matrix and current SNR value. The channel state information (CSI), however, contains the effective channel matrix instead of the actual channel matrix. So, in case of coordinated beamforming, there is no difference. But in case of non-coordinated beamforming, the effective channel matrix is the actual channel matrix followed by the compound combining matrix (G * H).
"""
snr: float | None = None
H: ComplexArray | None = None
[docs]
@dataclass()
class BaseStationState:
"""
The state of a base station (for a specific channel and SNR value).
Parameters
----------
F : ComplexArray, shape (Nt, K * Nr)
The compound precoding matrix.
C_eq : ComplexArray, shape (K * Nr,)
The equalization coefficients for each data stream.
ibr : IntArray, shape (K * Nr,)
The information bit rates for each data stream of each UT.
Ns : IntArray, shape (K,)
The number of data streams for each UT.
G : ComplexArray, shape (K * Nr, K * Nr) or None
The compound combining matrix. It is None in case of non-coordinated beamforming.
"""
F: ComplexArray
C_eq: ComplexArray
ibr: IntArray
Ns: IntArray
G: ComplexArray | None
[docs]
@dataclass()
class UserTerminalState:
"""
The state of a single user terminal (for a specific channel and SNR value).
Parameters
----------
H_k : ComplexArray, shape (Nr, Nt)
The channel matrix of this UT.
G_k : ComplexArray, shape (Nr, Nr)
The combining matrix of this UT.
c_type_k : ConstType
The constellation type for the data streams to this UT.
C_eq_k : ComplexArray, shape (Nr,)
The equalization coefficients for each data stream of this UT.
ibr_k : IntArray, shape (Nr,)
The information bit rates for each data stream of this UT.
Ns_k : int
The number of data streams for this UT.
"""
H_k: ComplexArray
G_k: ComplexArray
c_type_k: ConstType | None
C_eq_k: ComplexArray | None
ibr_k: IntArray | None
[docs]
@dataclass()
class TransmitPilotMessage:
"""
The pilot message transmitted by the BS.
"""
pass
[docs]
@dataclass()
class ReceivePilotMessage:
"""
The pilot message received by the UT.
Normally, the received pilot message would contain the received pilot symbols. However, since we consider channel estimation out of scope for this framework, we directly include the channel matrix in the received pilot message.
Parameters
----------
H_k : ComplexArray, shape (Nr, Nt)
The channel matrix of this UT.
"""
H_k: ComplexArray
[docs]
@dataclass()
class TransmitFeedbackMessage:
"""
The feedback message transmitted by the UT.
Parameters
----------
ut_id : int
The ID of the UT that transmits this feedback message.
H_eff_k : ComplexArray, shape (Nr, Nt)
The effective channel matrix of this UT.
"""
ut_id: int
H_eff_k: ComplexArray
[docs]
@dataclass()
class ReceiveFeedbackMessage:
"""
The feedback message received by the BS.
Parameters
----------
csi : ChannelStateInformation
The channel state information (CSI).
"""
csi: ChannelStateInformation
[docs]
@dataclass()
class TransmitFeedforwardMessage:
"""
The feedforward message transmitted by the BS.
Parameters
----------
c_type : list[ConstType]
The constellation types for the data streams to each UT.
C_eq : ComplexArray, shape (K * Nr,)
The equalization coefficients for each data stream of each UT.
ibr : IntArray, shape (K * Nr,)
The information bit rates for each data stream of each UT.
G : ComplexArray, shape (K * Nr, K * Nr)
The compound combining matrix. It is None in case of non-coordinated beamforming.
"""
c_type: list[ConstType]
C_eq: ComplexArray
ibr: IntArray
G: ComplexArray | None
[docs]
@dataclass()
class ReceiveFeedforwardMessage:
"""
The feedforward message received by the UT.
Parameters
----------
ut_id : int
The ID of the UT that receives this feedforward message.
c_type_k : ConstType
The constellation type for the data streams to this UT.
C_eq_k : ComplexArray, shape (Nr,)
The equalization coefficients for each data stream of this UT.
ibr_k : IntArray, shape (Nr,)
The information bit rates for each data stream of this UT.
G_k : ComplexArray, shape (Nr, Nr)
The combining matrix of this UT. It is None in case of non-coordinated beamforming.
"""
ut_id: int
c_type_k: ConstType
C_eq_k: ComplexArray
ibr_k: IntArray
G_k: ComplexArray | None
__all__ = [
"RealArray", "ComplexArray", "IntArray", "BitArray", "ConstType",
"ChannelStateInformation",
"ChannelState", "BaseStationState", "UserTerminalState",
"TransmitPilotMessage", "ReceivePilotMessage",
"TransmitFeedbackMessage", "ReceiveFeedbackMessage",
"TransmitFeedforwardMessage", "ReceiveFeedforwardMessage",
]