Struct Quantile 

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

A validated quantile value in the inclusive range 0.0..=1.0.

This newtype ensures that only valid quantile values (finite, non-NaN, within [0.0, 1.0]) are used as keys in QuantilesResult. Because NaN and infinity are excluded by construction, Quantile safely implements Eq and Ord.

Examples

use histogram::Quantile;

let q = Quantile::new(0.99).unwrap();
assert_eq!(q.as_f64(), 0.99);

// Invalid values are rejected
assert!(Quantile::new(1.5).is_err());
assert!(Quantile::new(f64::NAN).is_err());

Implementations

impl Quantile

pub fn new(value: f64) -> Result<Self, Error>

Create a new Quantile from a value in 0.0..=1.0.

Returns Error::InvalidQuantile if the value is outside the valid range or is NaN/infinite.

pub fn as_f64(self) -> f64

Returns the underlying f64 value.

Trait Implementations

impl Clone for Quantile

fn clone(&self) -> Quantile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Quantile

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

Formats the value using the given formatter.

impl Display for Quantile

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

Formats the value using the given formatter.

impl Ord for Quantile

fn cmp(&self, other: &Self) -> 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 Quantile

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

fn partial_cmp(&self, other: &Self) -> 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 TryFrom<f64> for Quantile

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: f64) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Quantile

impl Eq for Quantile