Enum DetectorKind 

#[non_exhaustive]
pub enum DetectorKind {
    Mr,
    Zf,
    Mmse,
    Sic,
    ZfSic,
    Ml,
    Sphere,
    KBest(usize),
    Amp(usize),
    Oamp(usize),
}

A detector of crate::detection.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Mr

Maximum ratio (matched filter).

Zf

Zero forcing.

Mmse

Unbiased MMSE.

Sic

MMSE successive interference cancellation (V-BLAST).

ZfSic

Zero-forcing successive interference cancellation.

Ml

Exhaustive maximum likelihood.

Sphere

The sphere decoder (maximum likelihood).

KBest(usize)

K-best with this number of paths.

Amp(usize)

LAMA, the complex Bayesian AMP of large systems, with this number of iterations.

Oamp(usize)

OAMP with the LMMSE estimator, with this number of iterations.

Implementations

impl DetectorKind

pub const DEFAULT_PATHS: usize = 8

The paths of K-best when its name does not give them.

pub const DEFAULT_ITERATIONS: usize = 10

The iterations of AMP and OAMP when their name does not give them.

pub const ALL: [DetectorKind; 10]

Every detector, K-best with DetectorKind::DEFAULT_PATHS paths and AMP and OAMP with DetectorKind::DEFAULT_ITERATIONS iterations.

pub const NAMES: [&'static str; 10]

The names of DetectorKind::ALL (DetectorKind::name), in order: the list of the detector names that the specifications take theirs from.

Examples

use comnum_mimo::receiver::DetectorKind;
assert_eq!(DetectorKind::NAMES.len(), DetectorKind::ALL.len());
for (name, d) in DetectorKind::NAMES.iter().zip(DetectorKind::ALL) {
    assert_eq!((d.name(), name.parse::<DetectorKind>()?), (*name, d));
}

pub const fn name(self) -> &'static str

The name of the detector, as DetectorKind::from_str reads it.

pub fn with_iterations(self, iterations: usize) -> Result<DetectorKind>

The same detector with iterations iterations, for AMP and OAMP (the others are returned unchanged).

Errors

Error::Config for zero iterations of AMP or OAMP.

pub fn from_name(name: &str, k: usize) -> Result<DetectorKind>

The detector of a name (DetectorKind::from_str), K-best with k paths.

Errors

Error::Config for another name or zero paths.

pub fn has_soft_output(self) -> bool

Whether the detector computes bit LLRs (MimoDetector::has_soft_output of its detector; false for a detector that cannot be built, K-best with no path).

pub fn detector( self, c: &Constellation, ) -> Result<Box<dyn MimoDetector + Send + Sync>>

The detector for the alphabet c.

Errors

Error::Config for K-best with no path or AMP and OAMP with no iteration.

Trait Implementations

impl Clone for DetectorKind

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DetectorKind

impl Debug for DetectorKind

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

Formats the value using the given formatter.

impl Eq for DetectorKind

impl FromStr for DetectorKind

fn from_str(name: &str) -> Result<DetectorKind>

The detector of a name: mr, zf, mmse, sic (mmse_sic), zf_sic, ml, sphere, kbest (with DetectorKind::DEFAULT_PATHS paths), amp (lama) or oamp (with DetectorKind::DEFAULT_ITERATIONS iterations), case-insensitive.

Errors

Error::Config for another name.

type Err = Error

The associated error which can be returned from parsing.

impl PartialEq for DetectorKind

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DetectorKind