Struct RelUncertainty

pub struct RelUncertainty<N> { /* private fields */ }

A relative uncertainty.

Relative uncertainties are characterized by a mean value and a coefficient of variation. The latter is the ratio of the standard deviation to the mean value.

Trait Implementations

impl<N: Float, U: Uncertainty<Float = N>> Add<U> for RelUncertainty<N>

type Output = RelUncertainty<N>

The resulting type after applying the + operator.

fn add(self, other: U) -> Self

Performs the + operation.

impl<N: Clone> Clone for RelUncertainty<N>

fn clone(&self) -> RelUncertainty<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Debug> Debug for RelUncertainty<N>

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

Formats the value using the given formatter.

impl<N: Default> Default for RelUncertainty<N>

fn default() -> RelUncertainty<N>

Returns the “default value” for a type.

impl<N: Float + Zero + Display> Display for RelUncertainty<N>

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

Formats the value using the given formatter.

impl<N: Float, U: Uncertainty<Float = N>> Div<U> for RelUncertainty<N>

type Output = RelUncertainty<N>

The resulting type after applying the / operator.

fn div(self, other: U) -> Self

Performs the / operation.

impl<N: Float> From<AbsUncertainty<N>> for RelUncertainty<N>

fn from(val: AbsUncertainty<N>) -> RelUncertainty<N>

Converts to this type from the input type.

impl<N: Float + Zero> From<RelUncertainty<N>> for AbsUncertainty<N>

fn from(val: RelUncertainty<N>) -> AbsUncertainty<N>

Converts to this type from the input type.

impl From<f64> for RelUncertainty<f64>

fn from(val: f64) -> RelUncertainty<f64>

Converts to this type from the input type.

impl<N: Float, U: Uncertainty<Float = N>> Mul<U> for RelUncertainty<N>

type Output = RelUncertainty<N>

The resulting type after applying the * operator.

fn mul(self, other: U) -> Self

Performs the * operation.

impl<N: PartialEq> PartialEq for RelUncertainty<N>

fn eq(&self, other: &RelUncertainty<N>) -> 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<N: Float, U: Uncertainty<Float = N>> Sub<U> for RelUncertainty<N>

type Output = RelUncertainty<N>

The resulting type after applying the - operator.

fn sub(self, other: U) -> Self

Performs the - operation.

impl<N: Float + Zero> Uncertainty for RelUncertainty<N>

type Float = N

The underlying float type for the uncertainty

fn new(mean: N, coefficient_of_variation: N) -> RelUncertainty<N>

fn mean(&self) -> N

Returns the mean of the value

fn standard_deviation(&self) -> N

The standard deviation of the value

fn coefficient_of_variation(&self) -> N

The coefficient of variation is the ratio of the standard deviation and the mean.

fn uncertainty(&self) -> N

The actual uncertainty of the concrete type. This will depend on whether the implementor represent a relative or absolute uncertainty.

fn is_certain(&self) -> bool

Returns true if the uncertainty is zero.

fn powi(&self, n: i32) -> Self

Raise the value to the nth power.

impl<N: Float + Zero> Zero for RelUncertainty<N>

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl<N: Copy> Copy for RelUncertainty<N>

impl<N> StructuralPartialEq for RelUncertainty<N>