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

Implementations

impl Prob

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

Methods from Deref<Target = f64>

pub const RADIX: u32

pub const MANTISSA_DIGITS: u32

pub const DIGITS: u32

pub const EPSILON: f64

pub const MIN: f64

pub const MIN_POSITIVE: f64

pub const MAX: f64

pub const MIN_EXP: i32

pub const MAX_EXP: i32

pub const MIN_10_EXP: i32

pub const MAX_10_EXP: i32

pub const NAN: f64

pub const INFINITY: f64

pub const NEG_INFINITY: f64

pub fn as_ne_bytes(&self) -> &[u8; 8]

🔬 This is a nightly-only experimental API. (num_as_ne_bytes)

Return the memory representation of this floating point number as a byte array in native byte order.

to_ne_bytes should be preferred over this whenever possible.

Examples

#![feature(num_as_ne_bytes)]
let num = 12.5f64;
let bytes = num.as_ne_bytes();
assert_eq!(
    bytes,
    if cfg!(target_endian = "big") {
        &[0x40, 0x29, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]
    } else {
        &[0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x29, 0x40]
    }
);

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

🔬 This is a nightly-only experimental API. (total_cmp)

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

• 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

Note that this function does not always agree with the PartialOrd and PartialEq implementations of f64. In particular, they regard negative and positive zero as equal, while total_cmp doesn’t.

Example

#![feature(total_cmp)]
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));

Trait Implementations

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

type Output = Prob

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for Prob

fn clone(&self) -> Prob

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Prob

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

type Target = f64

The resulting type after dereferencing.

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

Dereferences the value.

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

type Output = Prob

The resulting type after applying the / operator.

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

Performs the / operation.

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 f64

fn from(v: Prob) -> Self

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 From<f64> for Prob

fn from(v: f64) -> Self

Performs the conversion.

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

type Output = Prob

The resulting type after applying the * operator.

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

Performs the * operation.

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.

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

This method 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 StructuralPartialEq for Prob

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

type Output = Prob

The resulting type after applying the - operator.

fn sub(self, rhs: Prob) -> 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.

pub fn set_zero(&mut self)

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