Struct Confidence 

pub struct Confidence<S: Spread> { /* private fields */ }

The confidence of one estimate: a level with an optional spread, or no estimate. Either state carries at least one Reason.

The constructors keep the parts together: an estimate always has a level, and a “no estimate” state never has a level or a spread.

use sound_to_patch::confidence::{Confidence, Level, Reason, ReasonCode, Signal};
use sound_to_patch::units::Octaves;

let frames = Reason::new(ReasonCode::ActiveFrames, Signal::Count(412))?;
let cutoff = Confidence::estimate(Level::Medium, Some(Octaves::new(0.3)?), vec![frames])?;
assert_eq!(cutoff.level(), Some(Level::Medium));

let notes = Reason::new(ReasonCode::TooFewNotes, Signal::Count(2))?;
let envelope = Confidence::<Octaves>::no_estimate(vec![notes])?;
assert_eq!(envelope.level(), None);

A “no estimate” state takes no level:

use sound_to_patch::confidence::{Confidence, Level, NoSpread};

let _ = Confidence::<NoSpread>::no_estimate(Level::High, Vec::new());

Implementations

impl<S: Spread> Confidence<S>

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

Builds the confidence of an estimate.

Errors

Returns a ConfidenceError for an empty reason list or a negative spread.

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

Builds the state of a layer that had too little evidence to report a value.

Errors

Returns a ConfidenceError for an empty reason list.

pub fn is_estimate(&self) -> bool

Returns true unless this is a “no estimate” state.

pub fn level(&self) -> Option<Level>

Returns the level, or None for a “no estimate” state.

pub fn spread(&self) -> Option<S>

Returns the spread, if the estimate has one.

pub fn reasons(&self) -> &[Reason]

Returns the reasons, at least one.

Trait Implementations

impl<S: Clone + Spread> Clone for Confidence<S>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug + Spread> Debug for Confidence<S>

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

Formats the value using the given formatter.

impl<'de, S: Spread> Deserialize<'de> for Confidence<S>

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<S: PartialEq + Spread> PartialEq for Confidence<S>

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

Equality operator ==.

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

Inequality operator !=.

impl<S: Spread> Serialize for Confidence<S>

fn serialize<Ser: Serializer>( &self, serializer: Ser, ) -> Result<Ser::Ok, Ser::Error>

Serialize this value into the given Serde serializer.

impl<S: PartialEq + Spread> StructuralPartialEq for Confidence<S>