Struct Confidence 

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

A confidence value in [0.0, 1.0], stored as 16-bit fixed-point.

The representation gives a resolution of roughly 1.53e-5 per step and is bit-identical across architectures — no IEEE 754 divergence between CPUs. Per docs/concepts/ir-canonical-form.md § 3.1:

stored_u16 = round(confidence * 65535.0)
confidence = stored_u16 / 65535.0

Examples

use mimir_core::Confidence;

let c = Confidence::try_from_f32(0.95).unwrap();
assert!((c.as_f32() - 0.95).abs() < 1e-4);
assert_eq!(c.as_u16(), 62_258);

Implementations

impl Confidence

pub const ZERO: Self

Lowest confidence — 0.0.

pub const ONE: Self

Highest confidence — 1.0.

pub fn try_from_f32(value: f32) -> Result<Self, ConfidenceError>

Construct a Confidence from an f32 in [0.0, 1.0].

Rounds half-to-even.

Errors

• ConfidenceError::OutOfRange if value < 0.0 or value > 1.0.
• ConfidenceError::NotANumber if value is NaN.

Subnormal values and negative zero are treated as 0.0.

Examples

use mimir_core::{Confidence, ConfidenceError};

assert!(Confidence::try_from_f32(0.5).is_ok());
assert_eq!(
    Confidence::try_from_f32(1.1),
    Err(ConfidenceError::OutOfRange(1.1)),
);
assert_eq!(
    Confidence::try_from_f32(f32::NAN),
    Err(ConfidenceError::NotANumber),
);

pub const fn from_u16(raw: u16) -> Self

Construct a Confidence from its raw u16 fixed-point encoding.

pub const fn as_u16(self) -> u16

Raw u16 fixed-point encoding.

pub fn as_f32(self) -> f32

Floating-point representation in [0.0, 1.0].

Trait Implementations

impl Clone for Confidence

fn clone(&self) -> Confidence

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Confidence

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

Formats the value using the given formatter.

impl Display for Confidence

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

Formats the value using the given formatter.

impl Hash for Confidence

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Confidence

fn cmp(&self, other: &Confidence) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Confidence

fn eq(&self, other: &Confidence) -> 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 PartialOrd for Confidence

fn partial_cmp(&self, other: &Confidence) -> 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 Copy for Confidence

impl Eq for Confidence

impl StructuralPartialEq for Confidence