Skip to main content

BinomialInterval

Enum BinomialInterval 

Source
pub enum BinomialInterval {
    Wald,
    Wilson,
    AgrestiCoull,
    Jeffreys,
    ClopperPearson,
}
Expand description

A confidence interval of a binomial proportion $p$ from $k$ successes among $n$ trials, $\hat{p} = k/n$, $z = \Phi^{-1}(1 - \alpha/2)$ (Brown, Cai & DasGupta 2001, with their equations):

  • Wald, eq. (1): $\hat{p} \pm z \sqrt{\hat{p}(1 - \hat{p})/n}$, the textbook interval, whose coverage oscillates far below $1 - \alpha$ (a single point at $k = 0$ or $n$);
  • Wilson, eq. (4): the score interval (the default of the runner);
  • AgrestiCoull, eq. (5): the Wald interval of $\tilde{p} = (k + z^{2}/2)/(n + z^{2})$ with $\tilde{n} = n + z^{2}$, which contains the Wilson interval;
  • Jeffreys, eqs. (6)–(8): the $\alpha/2$ and $1 - \alpha/2$ quantiles of $\mathrm{Beta}(k + 1/2, n - k + 1/2)$, 0 at $k = 0$ and 1 at $k = n$;
  • ClopperPearson, Sec. 4.2.1: the quantiles of $\mathrm{Beta}(k, n - k + 1)$ and $\mathrm{Beta}(k + 1, n - k)$, the “exact” interval whose coverage never falls below $1 - \alpha$.

The Wald and Agresti–Coull intervals are returned as the paper defines them, not truncated to $[0, 1]$: their expected lengths are those of its Sec. 3.3 (Fig. 8), and truncating them would not change their coverage of $p \in (0, 1)$.

Variants§

§

Wald

The standard interval, eq. (1).

§

Wilson

The score interval, eq. (4).

§

AgrestiCoull

The Agresti–Coull interval, eq. (5).

§

Jeffreys

The equal-tailed Jeffreys interval, eqs. (6)–(8).

§

ClopperPearson

The Clopper–Pearson interval, Sec. 4.2.1.

Implementations§

Source§

impl BinomialInterval

Source

pub const ALL: [BinomialInterval; 5]

The five intervals.

Source

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

The name of the interval: wald, wilson, agresti_coull, jeffreys or clopper_pearson.

Trait Implementations§

Source§

impl Clone for BinomialInterval

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for BinomialInterval

Source§

impl Debug for BinomialInterval

Source§

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

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

impl Eq for BinomialInterval

Source§

impl FromStr for BinomialInterval

Source§

fn from_str(s: &str) -> Result<Self>

The interval of a BinomialInterval::name (any case, - for _).

Source§

type Err = Error

The associated error which can be returned from parsing.
Source§

impl Hash for BinomialInterval

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for BinomialInterval

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for BinomialInterval

Auto Trait Implementations§

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.