Enum PilotPattern 

#[non_exhaustive]
pub enum PilotPattern {
    Block {
        period: usize,
    },
    Comb {
        spacing: usize,
    },
    Lattice {
        freq: usize,
        time: usize,
    },
    Explicit(Arc<PilotTable>),
    None,
}

The positions of the pilots in the grid.

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.

Block

Every subcarrier of the symbols $l$ with $l \bmod$ period $= 0$.

Fields

period: usize

Pilot symbol period.

Comb

The subcarriers $k$ with $k \bmod$ spacing $= 0$ of every symbol.

Fields

spacing: usize

Pilot subcarrier spacing.

Lattice

The subcarriers $k \bmod$ freq $= 0$ of the symbols $l \bmod$ time $= 0$.

Fields

freq: usize

Pilot subcarrier spacing.

time: usize

Pilot symbol period.

Explicit(Arc<PilotTable>)

The pilots of a table: any positions, with their values.

None

No pilots (a receiver that knows the channel).

Implementations

impl PilotPattern

pub fn block(period: usize) -> Result<PilotPattern>

PilotPattern::Block: every subcarrier of one symbol in period.

Errors

Error::Config for a period of zero.

Examples

use comnum_waveform::ofdm::grid::PilotPattern;
assert_eq!(PilotPattern::block(4)?, PilotPattern::Block { period: 4 });
assert!(PilotPattern::block(0).is_err());

pub fn comb(spacing: usize) -> Result<PilotPattern>

PilotPattern::Comb: one subcarrier in spacing of every symbol.

Errors

Error::Config for a spacing of zero.

pub fn lattice(freq: usize, time: usize) -> Result<PilotPattern>

PilotPattern::Lattice: one subcarrier in freq of one symbol in time.

Errors

Error::Config for a spacing of zero.

Trait Implementations

impl Clone for PilotPattern

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 PilotPattern

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

Formats the value using the given formatter.

impl PartialEq for PilotPattern

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PilotPattern