Skip to main content

Uplink

Struct Uplink 

Source
pub struct Uplink {
    pub antennas: usize,
    pub large_scale: Vec<f64>,
    pub snr_lin: f64,
    pub pilots: Option<usize>,
}
Expand description

The uplink of $K$ users of large-scale fading large_scale to antennas antennas, at the normalised transmit SNR snr_lin of every user (see the module).

Fields§

§antennas: usize

The number $M$ of base-station antennas.

§large_scale: Vec<f64>

The large-scale fading $\beta_{k}$ of every user.

§snr_lin: f64

The normalised transmit SNR $p_{u}$ of every user (linear).

§pilots: Option<usize>

The length $\tau$ of the pilots of the estimated CSI; perfect CSI if None.

Implementations§

Source

pub fn new( antennas: usize, large_scale: Vec<f64>, snr_lin: f64, ) -> Result<Uplink>

The uplink with perfect CSI.

§Errors

Error::Config for no antenna or user, a large-scale fading that is not positive and finite, or an SNR that is not.

Source

pub fn with_pilots(self, tau: usize) -> Result<Uplink>

The uplink with the CSI estimated from orthogonal pilots of tau symbols.

§Errors

Error::Config for fewer pilot symbols than users.

Source

pub fn error_variance(&self) -> Vec<f64>

The variance $\varepsilon_{k}$ of every entry of the error of the channel estimate of every user, 0 with perfect CSI.

Source

pub fn estimate_variance(&self) -> Vec<f64>

The variance of every entry of the channel estimate $\hat G$ of every user: $\beta_{k} - \varepsilon_{k}$ ($\beta_{k}$ with perfect CSI).

Source

pub fn effective_noise_variance(&self) -> f64

The variance $1 + p_{u} \sum_{i} \varepsilon_{i}$ of the noise and of the estimation error at every antenna.

Source

pub fn rate_bound(&self, receiver: Criterion, k: usize) -> Result<f64>

The closed-form lower bound on the achievable rate of user k (bit/s/Hz) with the receiver receiver (see the module).

§Errors

Error::Config for a user out of range, MMSE (whose bound is an approximation, not implemented), MR with one antenna or ZF with $M \le K$.

Source

pub fn sum_rate_bound(&self, receiver: Criterion) -> Result<f64>

The sum over the users of Uplink::rate_bound (bit/s/Hz).

§Errors

As Uplink::rate_bound.

Trait Implementations§

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.