Struct ConfidenceLevel 

pub struct ConfidenceLevel<T>(/* private fields */);

A statistical confidence level.

Represents a probability in the closed interval [0, 1].

Common values include:

• 0.90 (90%)
• 0.95 (95%)
• 0.99 (99%)

A confidence level c corresponds to a significance level α = 1 - c.

Implementations

impl ConfidenceLevel<f32>

pub const CL90: Self

pub const CL95: Self

pub const CL975: Self

pub const CL99: Self

pub const CL999: Self

impl ConfidenceLevel<f64>

pub const CL90: Self

pub const CL95: Self

pub const CL975: Self

pub const CL99: Self

pub const CL999: Self

impl<T> ConfidenceLevel<T>

pub fn into_inner(self) -> T

Returns the probability associated with the confidence level

impl<T: Float> ConfidenceLevel<T>

pub fn new(probability: T) -> Result<Self, ValidationError>

Creates a confidence level from a probability.

Examples

use confi::ConfidenceLevel;

let cl = ConfidenceLevel::new(0.95)?;
assert_eq!(cl.into_inner(), 0.95);

Errors

• If the provided probability is outside [0, 1]
• If the provided probability is NaN

pub fn significance(self) -> SignificanceLevel<T>

Convert to the associated significance level

As confidence levels are checked for validity on creation the conversion is infallible

Examples

use confi::ConfidenceLevel;

let cl = ConfidenceLevel::new(0.95)?;
let significance = cl.significance();
approx::assert_relative_eq!(significance.into_inner(), 0.05);

impl<T: Float + FromPrimitive> ConfidenceLevel<T>

pub fn from_percent(percentage: T) -> Result<Self, ValidationError>

Creates a confidence level from a percentage.

Examples

use confi::ConfidenceLevel;

let cl = ConfidenceLevel::from_percent(95.0)?;
assert_eq!(cl.into_inner(), 0.95);

Errors

• If the provided percentage is outside [0, 100]
• If the provided percentage is NaN

impl<T: ToPrimitive> ConfidenceLevel<T>

pub fn to_f64(self) -> Option<ConfidenceLevel<f64>>

pub fn to_f32(self) -> Option<ConfidenceLevel<f32>>

Trait Implementations

impl<T: Clone> Clone for ConfidenceLevel<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for ConfidenceLevel<T>

impl<T: Debug> Debug for ConfidenceLevel<T>

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

Formats the value using the given formatter.

impl<T: ToPrimitive> Display for ConfidenceLevel<T>

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

Formats the value using the given formatter.

impl<T: Float> From<ConfidenceLevel<T>> for SignificanceLevel<T>

fn from(confidence_level: ConfidenceLevel<T>) -> Self

Converts to this type from the input type.

impl<T: Float> From<SignificanceLevel<T>> for ConfidenceLevel<T>

fn from(significance_level: SignificanceLevel<T>) -> Self

Converts to this type from the input type.

impl<T: PartialEq> PartialEq for ConfidenceLevel<T>

fn eq(&self, other: &ConfidenceLevel<T>) -> 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<T: PartialOrd> PartialOrd for ConfidenceLevel<T>

fn partial_cmp(&self, other: &ConfidenceLevel<T>) -> 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<T: PartialEq> StructuralPartialEq for ConfidenceLevel<T>