Enum Confidence 

pub enum Confidence {
    TwoSided(f64),
    UpperOneSided(f64),
    LowerOneSided(f64),
}

Confidence level of a confidence interval.

Operations

Creation

• Confidence::new - create a new two-sided confidence interval with the given confidence level
• Confidence::new_two_sided - idem
• Confidence::new_upper - create a new one-sided upper confidence interval with the given confidence level
• Confidence::new_lower - create a new one-sided lower confidence interval with the given confidence level

Accessors

• Confidence::level - return the confidence level of the interval as a number in the range (0, 1)
• Confidence::percent - return the confidence level of the interval as a percentage
• Confidence::kind - return the kind of the confidence interval as a string (in English)

Characteristics

• Confidence::is_two_sided - test if the confidence interval is two-sided
• Confidence::is_one_sided - test if the confidence interval is one-sided
• Confidence::is_upper - test if the confidence interval is upper (one-sided)
• Confidence::is_lower - test if the confidence interval is lower (one-sided)

Conversions

• Confidence::flipped - return the confidence interval with the same confidence level but flipped (e.g., upper to lower)

Comparison

Confidence implements PartialOrd where some confidence a is less than some confidence b if they are of the same kind and the confidence level of a is less than the confidence level of b.

Examples

Creation

To create a two-sided confidence interval with 95% confidence:

let confidence = Confidence::new_two_sided(0.95);
// alternatively:
let confidence = Confidence::new(0.95);

To create an upper one-sided confidence interval with 90% confidence:

let confidence = Confidence::new_upper(0.9);

To create a lower one-sided confidence interval with 99% confidence:

let confidence = Confidence::new_lower(0.99);

Accessors

The confidence object provides several accessors:

let confidence = Confidence::new(0.95);
assert_eq!(confidence.level(), 0.95);
assert_eq!(confidence.percent(), 95.);
assert_eq!(confidence.kind(), "two-sided");
assert!(confidence.is_two_sided());
assert!(!confidence.is_one_sided());
assert!(!confidence.is_upper());
assert!(!confidence.is_lower());

Conversions

let confidence = Confidence::new_upper(0.95);
assert_eq!(confidence.flipped(), Confidence::new_lower(0.95));

Comparison

let confidence = Confidence::new(0.95);
assert!(confidence > Confidence::new(0.9));
assert!(confidence < Confidence::new(0.99));

Variants

TwoSided(f64)

Confidence for a two-sided interval.

UpperOneSided(f64)

Confidence for an upper one-sided interval.

LowerOneSided(f64)

Confidence for a lower one-sided interval.

Implementations

impl Confidence

pub fn new(confidence: f64) -> Self

Create a new two-sided confidence interval with the given confidence level. This is the same as Confidence::new_two_sided.

Arguments

• confidence - the confidence level, e.g. 0.95 for 95% confidence

Panics

• if confidence is not in the range (0, 1)

pub fn new_two_sided(confidence: f64) -> Self

Create a new two-sided confidence interval with the given confidence level.

Arguments

• confidence - the confidence level, e.g. 0.95 for 95% confidence

Panics

• if confidence is not in the range (0, 1)

pub fn new_upper(confidence: f64) -> Self

Create a new one-sided upper confidence interval with the given confidence level.

Arguments

• confidence - the confidence level, e.g. 0.95 for 95% confidence

Panics

• if confidence is not in the range (0, 1)

pub fn new_lower(confidence: f64) -> Self

Create a new one-sided lower confidence interval with the given confidence level.

Arguments

• confidence - the confidence level, e.g. 0.95 for 95% confidence

Panics

• if confidence is not in the range (0, 1)

pub fn level(&self) -> f64

Return the confidence level of the interval as a number in the range (0, 1).

pub fn percent(&self) -> f64

Return the confidence level of the interval as a percentage.

pub fn kind(&self) -> &'static str

Return the kind of the confidence interval as a string (in English).

pub fn is_two_sided(&self) -> bool

Test if the confidence interval is two-sided.

pub fn is_one_sided(&self) -> bool

Test if the confidence interval is one-sided.

pub fn is_upper(&self) -> bool

Test if the confidence interval is upper (one-sided).

pub fn is_lower(&self) -> bool

Test if the confidence interval is lower (one-sided).

pub fn flipped(&self) -> Self

Return the confidence interval with the same confidence level but flipped. For a two-sided interval, this is the same interval. For a one-sided interval, this is the interval with the opposite direction. For example, a lower one-sided interval with confidence 0.95 flipped is an upper one-sided interval with confidence 0.95.

Trait Implementations

impl Clone for Confidence

fn clone(&self) -> Confidence

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Confidence

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

Formats the value using the given formatter.

impl Default for Confidence

fn default() -> Self

Create a new two-sided confidence interval with the default confidence level of 95%.

impl PartialEq for Confidence

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

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<f32> for Confidence

type Error = CIError

The type returned in the event of a conversion error.

fn try_from(confidence: f32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<f64> for Confidence

type Error = CIError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Confidence

impl StructuralPartialEq for Confidence