Struct SignalScore 

pub struct SignalScore { /* private fields */ }

A finite quantitative signal score with descriptive semantics.

Implementations

impl SignalScore

pub fn new(name: SignalName, score: f64) -> Result<SignalScore, SignalError>

Creates a signal score with unknown direction and strength.

Errors

Returns [SignalError::NonFiniteScore] when score is not finite.

pub fn with_direction(self, direction: SignalDirection) -> SignalScore

Sets descriptive direction vocabulary.

pub fn with_strength(self, strength: SignalStrength) -> SignalScore

Sets descriptive strength vocabulary.

pub const fn name(&self) -> &SignalName

Returns the signal name.

pub const fn score(&self) -> f64

Returns the numeric score.

pub const fn direction(&self) -> &SignalDirection

Returns the descriptive direction.

pub const fn strength(&self) -> &SignalStrength

Returns the descriptive strength.

Trait Implementations

impl Clone for SignalScore

fn clone(&self) -> SignalScore

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SignalScore

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

Formats the value using the given formatter.

impl PartialEq for SignalScore

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SignalScore