Struct Estimate 

pub struct Estimate<V, S: Spread> { /* private fields */ }

A value with its confidence. The value is present exactly when the confidence is an estimate.

use sound_to_patch::confidence::{Estimate, Level, Reason, ReasonCode, Signal};
use sound_to_patch::units::Hz;

let frames = Reason::new(ReasonCode::ActiveFrames, Signal::Count(412))?;
let centroid = Estimate::new(Hz::new(1520.0)?, Level::High, Some(Hz::new(310.0)?), vec![frames])?;
assert_eq!(centroid.value().map(|hz| hz.get()), Some(1520.0));

let silent = Reason::new(ReasonCode::SilentStem, Signal::Flag(true))?;
let none = Estimate::<Hz, Hz>::none(vec![silent])?;
assert!(none.value().is_none());

Implementations

impl<V, S: Spread> Estimate<V, S>

pub fn new( value: V, level: Level, spread: Option<S>, reasons: Vec<Reason>, ) -> Result<Self, ConfidenceError>

A value with the confidence of an estimate.

Errors

Returns a ConfidenceError as Confidence::estimate does.

pub fn none(reasons: Vec<Reason>) -> Result<Self, ConfidenceError>

No value, and the reasons why.

Errors

Returns a ConfidenceError as Confidence::no_estimate does.

pub fn value(&self) -> Option<&V>

Returns the value, or None for no estimate.

pub fn confidence(&self) -> &Confidence<S>

Returns the confidence.

Trait Implementations

impl<V: Clone, S: Clone + Spread> Clone for Estimate<V, S>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<V: Debug, S: Debug + Spread> Debug for Estimate<V, S>

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

Formats the value using the given formatter.

impl<V: PartialEq, S: PartialEq + Spread> PartialEq for Estimate<V, S>

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

Equality operator ==.

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

Inequality operator !=.

impl<V: PartialEq, S: PartialEq + Spread> StructuralPartialEq for Estimate<V, S>