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));

Tuple Fields

0: f64

Implementations

impl Prob

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

Methods from Deref<Target = f64>

pub const RADIX: u32 = 2u32

pub const MANTISSA_DIGITS: u32 = 53u32

pub const DIGITS: u32 = 15u32

pub const EPSILON: f64 = 2.2204460492503131E-16f64

pub const MIN: f64 = -1.7976931348623157E+308f64

pub const MIN_POSITIVE: f64 = 2.2250738585072014E-308f64

pub const MAX: f64 = 1.7976931348623157E+308f64

pub const MIN_EXP: i32 = -1_021i32

pub const MAX_EXP: i32 = 1_024i32

pub const MIN_10_EXP: i32 = -307i32

pub const MAX_10_EXP: i32 = 308i32

pub const NAN: f64 = NaN_f64

pub const INFINITY: f64 = +Inf_f64

pub const NEG_INFINITY: f64 = -Inf_f64

pub fn total_cmp(&self, other: &f64) -> Ordering

Returns the ordering between self and other.

Unlike the standard partial comparison between floating point numbers, this comparison always produces an ordering in accordance to the totalOrder predicate as defined in the IEEE 754 (2008 revision) floating point standard. The values are ordered in the following sequence:

• negative quiet NaN
• negative signaling NaN
• negative infinity
• negative numbers
• negative subnormal numbers
• negative zero
• positive zero
• positive subnormal numbers
• positive numbers
• positive infinity
• positive signaling NaN
• positive quiet NaN.

The ordering established by this function does not always agree with the PartialOrd and PartialEq implementations of f64. For example, they consider negative and positive zero equal, while total_cmp doesn’t.

The interpretation of the signaling NaN bit follows the definition in the IEEE 754 standard, which may not match the interpretation by some of the older, non-conformant (e.g. MIPS) hardware implementations.

Example

struct GoodBoy {
    name: String,
    weight: f64,
}

let mut bois = vec![
    GoodBoy { name: "Pucci".to_owned(), weight: 0.1 },
    GoodBoy { name: "Woofer".to_owned(), weight: 99.0 },
    GoodBoy { name: "Yapper".to_owned(), weight: 10.0 },
    GoodBoy { name: "Chonk".to_owned(), weight: f64::INFINITY },
    GoodBoy { name: "Abs. Unit".to_owned(), weight: f64::NAN },
    GoodBoy { name: "Floaty".to_owned(), weight: -5.0 },
];

bois.sort_by(|a, b| a.weight.total_cmp(&b.weight));

// `f64::NAN` could be positive or negative, which will affect the sort order.
if f64::NAN.is_sign_negative() {
    assert!(bois.into_iter().map(|b| b.weight)
        .zip([f64::NAN, -5.0, 0.1, 10.0, 99.0, f64::INFINITY].iter())
        .all(|(a, b)| a.to_bits() == b.to_bits()))
} else {
    assert!(bois.into_iter().map(|b| b.weight)
        .zip([-5.0, 0.1, 10.0, 99.0, f64::INFINITY, f64::NAN].iter())
        .all(|(a, b)| a.to_bits() == b.to_bits()))
}

Trait Implementations

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<'a> Add for &'a Prob

type Output = Prob

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Prob

type Output = Prob

The resulting type after applying the + operator.

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

Performs the + operation.

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 Debug for Prob

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

Formats the value using the given formatter.

impl Default for Prob

fn default() -> Prob

Returns the “default value” for a type.

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.

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<'a> Div for &'a Prob

type Output = Prob

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for Prob

type Output = Prob

The resulting type after applying the / operator.

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

Performs the / operation.

impl From<LogProb> for Prob

fn from(p: LogProb) -> Prob

Converts to this type from the input type.

impl From<PHREDProb> for Prob

fn from(p: PHREDProb) -> Prob

Converts to this type from the input type.

impl From<Prob> for LogProb

fn from(p: Prob) -> LogProb

Converts to this type from the input type.

impl From<Prob> for PHREDProb

fn from(p: Prob) -> PHREDProb

Converts to this type from the input type.

impl From<Prob> for f64

fn from(v: Prob) -> Self

Converts to this type from the input type.

impl From<f64> for Prob

fn from(v: f64) -> Self

Converts to this type from the input type.

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<'a> Mul for &'a Prob

type Output = Prob

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for Prob

type Output = Prob

The resulting type after applying the * operator.

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

Performs the * operation.

impl PartialEq for Prob

fn eq(&self, other: &Prob) -> 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 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: &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 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<'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<'a> Sub for &'a Prob

type Output = Prob

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for Prob

type Output = Prob

The resulting type after applying the - operator.

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

Performs the - operation.

impl Zero for Prob

fn zero() -> Self

Returns the additive identity element of Self, 0.

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 Deref for Prob

type Target = f64

The resulting type after dereferencing.

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

Dereferences the value.

impl Copy for Prob

impl StructuralPartialEq for Prob