SignificanceLevel

Struct SignificanceLevel 

Source
pub struct SignificanceLevel<T>(/* private fields */);
Expand description

The significance level is expressed as a fraction.

It represents the probability of a type I error, which corresponds to rejection of a null hypothesis which is in fact true.

Implementations§

Source§

impl<T: Float + FromPrimitive + ToPrimitive> SignificanceLevel<T>

Source

pub fn into_inner(self) -> T

Returns the wrapped value as a fraction

Source

pub fn fractional(level: T) -> Result<Self, ConfidenceError>

Create a new significance value from a fractional level

§Errors
  • If the provided value is outside [0, 1], or is NaN
Source

pub fn percentage(level: T) -> Result<Self, ConfidenceError>

Create a new significance value from a percentage level

§Errors
  • If the provided value is outside [0, 100], or is NaN
Source

pub fn zero_point_one_percent() -> Self

Create a new significance value representing a significance level of 0.1%

Source

pub fn zero_point_five_percent() -> Self

Create a new significance value representing a significance level of 0.5%

Source

pub fn one_percent() -> Self

Create a new significance value representing a significance level of 1.0%

Source

pub fn two_point_five_percent() -> Self

Create a new significance value representing a significance level of 2.5%

Source

pub fn five_percent() -> Self

Create a new significance value representing a significance level of 5.0%

Source

pub fn ten_percent() -> Self

Create a new significance value representing a significance level of 10.0%

Source

pub fn probability(&self) -> T

Return the numerical value associated with the significance level

Source

pub fn num_standard_deviations(&self) -> Result<T, NormalError>

The number of standard deviations from the distribution center represented by the significance level.

This is found by calculating the inverse cumululative distribution function at the significance level. The inverse CDF gives the value of the measurand which leads to the given probability. The number of standard deviations is this divided by the standard deviation of the distribution

Source§

impl<T: ToPrimitive> SignificanceLevel<T>

Trait Implementations§

Source§

impl<T: Clone> Clone for SignificanceLevel<T>

Source§

fn clone(&self) -> SignificanceLevel<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> Debug for SignificanceLevel<T>

Source§

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

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

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

Source§

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

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

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

impl<T: PartialEq> PartialEq for SignificanceLevel<T>

Source§

fn eq(&self, other: &SignificanceLevel<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: Copy> Copy for SignificanceLevel<T>

Source§

impl<T> StructuralPartialEq for SignificanceLevel<T>

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

impl<T> UnwindSafe for SignificanceLevel<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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,