Struct FieldAmplitude 

pub struct FieldAmplitude(/* private fields */);

A finite non-negative scalar field amplitude.

A negative real contribution is represented by phase, not by a signed amplitude, so zero is admitted while negative values are rejected.

Implementations

impl FieldAmplitude

pub const NAME: &'static str = "field-amplitude"

Stable diagnostic name.

pub fn new(value: f64) -> Result<Self, InterferenceError>

Admits a finite amplitude greater than or equal to zero.

pub fn get(self) -> f64

Returns the validated field amplitude.

Trait Implementations

impl Clone for FieldAmplitude

fn clone(&self) -> FieldAmplitude

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for FieldAmplitude

impl Debug for FieldAmplitude

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

Formats the value using the given formatter.

impl PartialEq for FieldAmplitude

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for FieldAmplitude

fn partial_cmp(&self, other: &FieldAmplitude) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for FieldAmplitude