Struct UnitInterval 

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

Re-export canonical pack value types used by core public structs. A finite value in the inclusive [0.0, 1.0] range.

Use this for confidence, normalized scores, prior weights, and thresholds.

Implementations

impl UnitInterval

pub const ZERO: UnitInterval

The minimum unit interval value.

pub const ONE: UnitInterval

The maximum unit interval value.

pub fn new(value: f64) -> Result<UnitInterval, UnitIntervalError>

Create a validated unit interval.

Returns an error for NaN, infinity, or values outside [0.0, 1.0].

pub fn clamped(value: f64) -> UnitInterval

Create a unit interval by clamping finite input.

Non-finite values become 0.0.

pub fn as_f64(self) -> f64

Return the underlying f64.

pub fn saturating_add(self, delta: f64) -> UnitInterval

Add a delta and clamp the result back into the valid range.

pub fn scale_by(self, factor: UnitInterval) -> UnitInterval

Multiply two unit interval values.

pub fn to_basis_points(self) -> u16

Convert to basis points, rounded to the nearest basis point.

Trait Implementations

impl Clone for UnitInterval

fn clone(&self) -> UnitInterval

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnitInterval

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

Formats the value using the given formatter.

impl Default for UnitInterval

fn default() -> UnitInterval

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UnitInterval

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for UnitInterval

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

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<f64> for UnitInterval

type Error = UnitIntervalError

The type returned in the event of a conversion error.

fn try_from( value: f64, ) -> Result<UnitInterval, <UnitInterval as TryFrom<f64>>::Error>

Performs the conversion.

impl Copy for UnitInterval

impl StructuralPartialEq for UnitInterval