Skip to main content

Estimate

Struct Estimate 

Source
pub struct Estimate<T: PartialOrd + Copy> {
    pub point: T,
    pub lower: T,
    pub upper: T,
}
Expand description

A physical measurement: point estimate ± 95 % confidence interval.

Invariant: lower ≤ point ≤ upper

Eq and Hash are intentionally NOT derived for Estimate<f64>. Floating-point equality is physically meaningless for measurements. Use Estimate::is_consistent_with for physically meaningful comparison.

Fields§

§point: T

Best single-value estimate (e.g. mean or median of samples).

§lower: T

Lower bound of the 95 % confidence interval.

§upper: T

Upper bound of the 95 % confidence interval.

Implementations§

Source§

impl<T: PartialOrd + Copy + Display> Estimate<T>

Source

pub fn new(point: T, lower: T, upper: T) -> Result<Self, EstimateError>

Constructs a new estimate, enforcing lower ≤ point ≤ upper.

§Errors

Returns EstimateError::InvalidBounds if the invariant is violated.

Source

pub fn exact(value: T) -> Self

Creates an exact estimate with zero uncertainty. Use for quantities known with mathematical certainty (e.g. counting).

Source§

impl Estimate<f64>

Source

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

Two estimates are physically consistent if their confidence intervals overlap.

This is the correct notion of “agreement” between two uncertain measurements.

Source

pub fn relative_uncertainty(&self) -> f64

Relative uncertainty: (upper − lower) / |point|.

Returns f64::INFINITY when |point| is below machine epsilon (cannot compute a meaningful relative uncertainty for a near-zero quantity).

Source

pub fn with_extra_uncertainty(&self, factor: f64) -> Self

Returns a widened copy with interval expanded by factor (≥ 1.0).

Useful when composing multiple uncertain quantities conservatively.

Trait Implementations§

Source§

impl<T: Clone + PartialOrd + Copy> Clone for Estimate<T>

Source§

fn clone(&self) -> Estimate<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug + PartialOrd + Copy> Debug for Estimate<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de, T> Deserialize<'de> for Estimate<T>
where T: Deserialize<'de> + PartialOrd + Copy,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<T: PartialOrd + Copy + Display> Display for Estimate<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: PartialEq + PartialOrd + Copy> PartialEq for Estimate<T>

Source§

fn eq(&self, other: &Estimate<T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T> Serialize for Estimate<T>
where T: Serialize + PartialOrd + Copy,

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl<T: Copy + PartialOrd + Copy> Copy for Estimate<T>

Source§

impl<T: PartialOrd + Copy> StructuralPartialEq for Estimate<T>

Auto Trait Implementations§

§

impl<T> Freeze for Estimate<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Estimate<T>
where T: RefUnwindSafe,

§

impl<T> Send for Estimate<T>
where T: Send,

§

impl<T> Sync for Estimate<T>
where T: Sync,

§

impl<T> Unpin for Estimate<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Estimate<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for Estimate<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,