Skip to main content

Metric

comnum_spec::metrics

Enum Metric 

Source 
pub enum Metric {

Show 17 variants    Ber,
    Ser,
    SnrDb,
    SnrEffDb,
    Evm,
    Mse,
    Gmi,
    Ngmi,
    Mi,
    Entropy,
    Air,
    AirBmd,
    AirOpt,
    AirBmdOpt,
    PosteriorCalibration,
    CodedBer,
    Bler,

}
Expand description

A metric of a declarative link (see the module documentation).

Variants§

§

Ber

ber.

§

Ser

ser.

§

SnrDb

snr_db.

§

SnrEffDb

snr_eff_db.

§

Evm

evm.

§

Mse

mse.

§

Gmi

gmi.

§

Ngmi

ngmi.

§

Mi

mi.

§

Entropy

entropy.

§

Air

air.

§

AirBmd

air_bmd.

§

AirOpt

air_opt.

§

AirBmdOpt

air_bmd_opt.

§

PosteriorCalibration

posterior_calibration.

§

CodedBer

coded_ber.

§

Bler

bler.

Implementations§

Source§

impl Metric

Source

pub const ALL: [Metric; 17]

Every metric.

Source

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

The name of the metric in a specification and in the results.

Source

pub fn is_coded(self) -> bool

Whether the metric is computed on the decoded information bits.

Trait Implementations§

Source§

impl Clone for Metric

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 Copy for Metric

Source§

impl Debug for Metric

Source§

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

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

impl Eq for Metric

Source§

impl FromStr for Metric

Source§

fn from_str(s: &str) -> Result<Metric>

The metric of a name, without case.

§Errors

Error::Config for an unknown name (the message lists the metrics).

§Examples
use comnum_spec::metrics::Metric;
assert_eq!("BER".parse::<Metric>()?, Metric::Ber);
assert!("fer".parse::<Metric>().is_err());
Source§

type Err = Error

The associated error which can be returned from parsing.
Source§

impl PartialEq for Metric

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 Metric

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.