Enum ConstellationKind 

#[non_exhaustive]
pub enum ConstellationKind {
    Pam,
    Qam,
    Psk,
    Ook,
    Custom,
}

The family of a constellation.

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.

Pam

Pulse amplitude modulation (real).

Qam

Square quadrature amplitude modulation.

Psk

Phase shift keying.

Ook

On-off keying {0, 1} (real).

Custom

Points given by the user (Constellation::from_points).

Implementations

impl ConstellationKind

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

The name of the family: "pam", "qam", "psk", "ook" or "custom" (the names that ConstellationKind::from_str reads, but the last).

Examples

use comnum_mapping::constellation::ConstellationKind;
let k: ConstellationKind = "QAM".parse()?;
assert_eq!(k.name(), "qam");

pub fn is_real(self) -> bool

Whether the constellation is real (one real dimension per symbol).

Trait Implementations

impl Clone for ConstellationKind

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 ConstellationKind

impl Debug for ConstellationKind

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

Formats the value using the given formatter.

impl Eq for ConstellationKind

impl FromStr for ConstellationKind

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

Parse "pam", "qam", "psk" or "ook" (the constType of OptiCommPy), case-insensitive.

Errors

Error::Config for an unknown name.

type Err = Error

The associated error which can be returned from parsing.

impl Hash for ConstellationKind

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ConstellationKind

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ConstellationKind