Struct KBest 

pub struct KBest { /* private fields */ }

The K-best tree search: breadth first from the last stream, keeping the k paths of smallest partial distance at every level.

Implementations

impl KBest

pub fn new(constellation: Constellation, k: usize) -> Result<KBest>

The search keeping k paths, the LLRs of the bits whose counter-hypothesis left the list clipped at KNOWN_BIT_LLR.

Errors

Error::Config for $k = 0$.

pub fn with_llr_clip(self, llr_clip: f64) -> Result<KBest>

The same search with the LLR magnitude llr_clip for a bit whose counter-hypothesis left the list.

Errors

Error::Config for a magnitude that is not positive.

pub fn k(&self) -> usize

Paths kept at every level.

pub fn llr_clip(&self) -> f64

Magnitude of the LLR of a bit whose counter-hypothesis left the list.

Trait Implementations

impl Clone for KBest

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KBest

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

Formats the value using the given formatter.

impl MimoDetector for KBest

fn constellation(&self) -> &Constellation

The alphabet of every stream (the labels of MimoDetector::detect index its points).

fn has_soft_output(&self) -> bool

Whether MimoDetector::llr gives bit LLRs (false: it returns an error).

fn detect( &self, h: &ArrayView2<'_, C64>, y: &[C64], noise_var: f64, ) -> Result<Vec<usize>>

The label of the decided point of every transmit stream.

fn llr( &self, h: &ArrayView2<'_, C64>, y: &[C64], noise_var: f64, ) -> Result<Vec<f64>>

Bit LLRs, $n_{t} \log_{2} M$ of them (positive for a 0).

fn detect_llr( &self, h: &ArrayView2<'_, C64>, y: &[C64], noise_var: f64, ) -> Result<(Vec<usize>, Vec<f64>)>

The labels and the bit LLRs of one channel use, those of MimoDetector::detect and MimoDetector::llr; the detectors with soft output get both from one search.

fn detect_block( &self, h: &ArrayView2<'_, C64>, y: &ArrayView2<'_, C64>, noise_var: f64, ) -> Result<Array2<usize>>

Detect every column of y (n_rx × T) with the same channel: the labels, n_tx × T. The detectors of this module factor the channel once for the block.

fn soft_estimate( &self, _h: &ArrayView2<'_, C64>, _y: &[C64], _noise_var: f64, ) -> Result<Option<Estimates>>

The estimates of the transmitted symbols and their noise variances, when the detector forms them (None for the detectors that decide on the lattice).

impl PartialEq for KBest

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for KBest