Struct bio::stats::probs::Prob

pub struct Prob(pub f64);

A newtype for probabilities.

Example

#[macro_use]
extern crate approx;
use bio::stats::Prob;

let p = Prob(0.5);
let q = Prob(0.2);

assert_relative_eq!(*(p + q), *Prob(0.7));

Methods

impl Prob

pub fn checked(p: f64) -> Result<Self, ProbError>

Trait Implementations

impl Clone for Prob

fn clone(&self) -> Prob

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Prob

impl From<f64> for Prob

fn from(v: f64) -> Self

Performs the conversion.

impl From<Prob> for f64

fn from(v: Prob) -> Self

Performs the conversion.

impl From<LogProb> for Prob

fn from(p: LogProb) -> Prob

Performs the conversion.

impl From<PHREDProb> for Prob

fn from(p: PHREDProb) -> Prob

Performs the conversion.

impl From<Prob> for LogProb

fn from(p: Prob) -> LogProb

Performs the conversion.

impl From<Prob> for PHREDProb

fn from(p: Prob) -> PHREDProb

Performs the conversion.

impl Default for Prob

fn default() -> Prob

Returns the "default value" for a type.

impl PartialEq<Prob> for Prob

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Prob> for Prob

fn partial_cmp(&self, other: &Prob) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Prob) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Prob) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Prob) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Prob) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Debug for Prob

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

Formats the value using the given formatter.

impl Div<Prob> for Prob

type Output = Prob

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Prob

Performs the / operation.

impl<'a> Div<&'a Prob> for &'a Prob

type Output = Prob

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Prob

Performs the / operation.

impl<'a> Div<&'a Prob> for Prob

type Output = Prob

The resulting type after applying the / operator.

fn div(self, rhs: &'a Prob) -> Prob

Performs the / operation.

impl<'a> Div<Prob> for &'a Prob

type Output = Prob

The resulting type after applying the / operator.

fn div(self, rhs: Prob) -> Prob

Performs the / operation.

impl Add<Prob> for Prob

type Output = Prob

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Prob

Performs the + operation.

impl<'a> Add<&'a Prob> for &'a Prob

type Output = Prob

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Prob

Performs the + operation.

impl<'a> Add<&'a Prob> for Prob

type Output = Prob

The resulting type after applying the + operator.

fn add(self, rhs: &'a Prob) -> Prob

Performs the + operation.

impl<'a> Add<Prob> for &'a Prob

type Output = Prob

The resulting type after applying the + operator.

fn add(self, rhs: Prob) -> Prob

Performs the + operation.

impl Sub<Prob> for Prob

type Output = Prob

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Prob

Performs the - operation.

impl<'a> Sub<&'a Prob> for &'a Prob

type Output = Prob

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Prob

Performs the - operation.

impl<'a> Sub<&'a Prob> for Prob

type Output = Prob

The resulting type after applying the - operator.

fn sub(self, rhs: &'a Prob) -> Prob

Performs the - operation.

impl<'a> Sub<Prob> for &'a Prob

type Output = Prob

The resulting type after applying the - operator.

fn sub(self, rhs: Prob) -> Prob

Performs the - operation.

impl Mul<Prob> for Prob

type Output = Prob

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Prob

Performs the * operation.

impl<'a> Mul<&'a Prob> for &'a Prob

type Output = Prob

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Prob

Performs the * operation.

impl<'a> Mul<&'a Prob> for Prob

type Output = Prob

The resulting type after applying the * operator.

fn mul(self, rhs: &'a Prob) -> Prob

Performs the * operation.

impl<'a> Mul<Prob> for &'a Prob

type Output = Prob

The resulting type after applying the * operator.

fn mul(self, rhs: Prob) -> Prob

Performs the * operation.

impl Deref for Prob

type Target = f64

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Zero for Prob

fn zero() -> Self

Returns the additive identity element of Self, 0. # Purity

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl Serialize for Prob

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Prob

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.