Enum StepDistribution 

#[non_exhaustive]
pub enum StepDistribution {
    Uniform,
    Logarithmic,
    ModifiedLogarithmic(f64),
}

The distribution of the steps of a span of a back-propagation (comnum_dsp::compensation::dbp::Dbp::distribution).

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.

Uniform

Equal steps.

Logarithmic

The logarithmic steps of logarithmic_steps (Bosco et al. 2000, eq. (6)).

ModifiedLogarithmic(f64)

The modified logarithmic steps of Zhang, Li and Dong (2013, eq. (2)): the steps of logarithmic_steps for the attenuation times this adjusting factor (0.4 recommended), less concentrated at the start of the span. As described by Häger and Pfister (2021, Sec. IV-C), whose Example 1 the tests check: two steps over a span of 100 km at 0.2 dB/km are about 30 and 70 km (15 and 85 km with the factor 1).

Implementations

impl StepDistribution

pub fn steps( self, alpha_np_km: f64, length_km: f64, n: usize, ) -> Result<Vec<f64>>

The n steps of a span of length_km with the power attenuation alpha_np_km (Np/km), in the order of the propagation.

Errors

As logarithmic_steps.

Trait Implementations

impl Clone for StepDistribution

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 StepDistribution

impl Debug for StepDistribution

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

Formats the value using the given formatter.

impl Default for StepDistribution

fn default() -> Self

Returns the “default value” for a type.

impl FromStr for StepDistribution

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

uniform, logarithmic or modified_logarithmic (the recommended factor 0.4; case-insensitive).

type Err = Error

The associated error which can be returned from parsing.

impl PartialEq for StepDistribution

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for StepDistribution