Struct Distribution 

pub struct Distribution { /* private fields */ }

The values a sample of runs gave, sorted, and how many runs were tried. It serializes as those two, and reads back through Distribution::new’s checks.

Implementations

impl Distribution

pub fn new(values: Vec<f64>, attempted: usize) -> Result<Self, AnalysisError>

The distribution of values, from attempted runs (those that gave no value make up the difference).

Errors

• AnalysisError::Domain for a value that isn’t finite.
• AnalysisError::Count for more values than runs.

pub fn attempted(&self) -> usize

The runs tried.

pub fn count(&self) -> usize

The runs that gave a value.

pub fn missing(&self) -> usize

The runs that gave no value: failed, or without the quantity asked for.

pub fn sorted(&self) -> &[f64]

The values, smallest first.

pub fn min(&self) -> Option<f64>

The smallest value, None with no values.

pub fn max(&self) -> Option<f64>

The largest value, None with no values.

pub fn mean(&self) -> Option<f64>

The mean, x₀ + Σ(xᵢ − x₀)/n with x₀ the smallest value; None with no values.

pub fn standard_deviation(&self) -> Option<f64>

The sample standard deviation, √(Σ(dᵢ − d̄)²/(n − 1)) with dᵢ = xᵢ − x₀; None with fewer than two values.

pub fn quantile(&self, p: f64) -> Result<Option<f64>, AnalysisError>

The p quantile by Hyndman and Fan’s definition 7 (the module’s docs); None with no values.

Errors

AnalysisError::Domain for p outside [0, 1].

pub fn share_at_least( &self, threshold: f64, ) -> Result<Option<Share>, AnalysisError>

Bounds on the share of the runs tried whose value is at least threshold (Share); None with no runs tried, when there is no share to bound. An infinite threshold is allowed.

Errors

AnalysisError::Domain for a threshold that is not a number.

pub fn summary(&self) -> Summary

The usual numbers, for a report: Summary.

Trait Implementations

impl Clone for Distribution

fn clone(&self) -> Distribution

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Distribution

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Distribution

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Distribution

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

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 Distribution