Skip to main content

MessagePassing

Struct MessagePassing 

Source
pub struct MessagePassing {
    pub prior: Prior,
    pub domain: Domain,
    pub iterations: usize,
}
Expand description

The configuration shared by lama, oamp and their state evolutions: the prior of every entry of $x$, the domain of the model and the number of iterations.

§Examples

use comnum_mimo::message_passing::{Domain, MessagePassing, Prior, amp_state_evolution};
use comnum_mapping::constellation::Constellation;
let qpsk = Prior::uniform(&Constellation::qam(4)?.normalized());
let config = MessagePassing { prior: qpsk, iterations: 30, ..MessagePassing::default() };
config.check()?;
let se = amp_state_evolution(&config, 0.5, 0.05);
assert_eq!(se.len(), 30);

Fields§

§prior: Prior

The prior of every entry of $x$.

§domain: Domain

The domain of the symbols, the channel and the noise.

§iterations: usize

Iterations (at least 1 for the detectors).

Implementations§

Source§

impl MessagePassing

Source

pub fn check(&self) -> Result<()>

Check the configuration.

§Errors

Error::Config for zero iterations or a sparsity outside $(0, 1]$; Error::Shape for a discrete prior without points or with one probability per point missing.

Trait Implementations§

Source§

impl Clone for MessagePassing

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§

impl Debug for MessagePassing

Source§

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

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

impl Default for MessagePassing

Source§

fn default() -> MessagePassing

A Gaussian prior of unit variance (Prior::BernoulliGaussian with $\rho = 1$), complex, 10 iterations.

Source§

impl PartialEq for MessagePassing

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
Source§

impl StructuralPartialEq for MessagePassing

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.