Struct MetricValue 

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

A type-safe metric value bounded to [0.0, 1.0].

Ensures metrics like precision, recall, and F1 are always valid.

Implementations

impl MetricValue

pub fn new(value: f64) -> Self

Create a new MetricValue, clamping to [0.0, 1.0].

Example

use anno_eval::eval::MetricValue;
let v = MetricValue::new(0.95);
assert!((v.get() - 0.95).abs() < 1e-6);

pub fn try_new(value: f64) -> Result<Self>

Try to create a MetricValue, returning error if out of bounds.

pub fn get(&self) -> f64

Get the underlying value.

Trait Implementations

impl Clone for MetricValue

fn clone(&self) -> MetricValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MetricValue

impl Debug for MetricValue

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

Formats the value using the given formatter.

impl Default for MetricValue

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MetricValue

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MetricValue

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

Formats the value using the given formatter.

impl From<f64> for MetricValue

fn from(value: f64) -> Self

Converts to this type from the input type.

impl PartialEq for MetricValue

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MetricValue