Struct Probability 

pub struct Probability<T>(/* private fields */)
where
    T: FloatBounds;

Type-safe probability value constrained to [0, 1]

Implementations

impl<T> Probability<T>

where T: FloatBounds,

pub fn new(value: T) -> Result<Probability<T>, SklearsError>

Create a new probability value, returning an error if not in [0, 1]

pub unsafe fn new_unchecked(value: T) -> Probability<T>

Create a probability value without validation (unsafe)

Safety

The caller must ensure the value is in [0, 1]

pub fn value(self) -> T

Get the raw probability value

pub fn as_f64(self) -> f64

where T: ToPrimitive,

Convert to f64 for compatibility

pub fn is_zero(self) -> bool

Check if this is effectively zero (within machine epsilon)

pub fn is_one(self) -> bool

Check if this is effectively one (within machine epsilon)

pub fn complement(self) -> Probability<T>

Complement probability (1 - p)

pub fn ln(self) -> T

Logarithm of probability (useful for log-likelihood computations)

pub fn sigmoid(x: T) -> Probability<T>

Sigmoid function to convert any real number to probability

Trait Implementations

impl<T> Add for Probability<T>

where T: FloatBounds,

type Output = Result<Probability<T>, SklearsError>

The resulting type after applying the + operator.

fn add(self, other: Probability<T>) -> <Probability<T> as Add>::Output

Performs the + operation.

impl<T> Clone for Probability<T>

where T: Clone + FloatBounds,

fn clone(&self) -> Probability<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Probability<T>

where T: Debug + FloatBounds,

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

Formats the value using the given formatter.

impl<T> Display for Probability<T>

where T: FloatBounds,

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

Formats the value using the given formatter.

impl<T> Mul for Probability<T>

where T: FloatBounds,

type Output = Probability<T>

The resulting type after applying the * operator.

fn mul(self, other: Probability<T>) -> <Probability<T> as Mul>::Output

Performs the * operation.

impl<T> PartialEq for Probability<T>

where T: PartialEq + FloatBounds,

fn eq(&self, other: &Probability<T>) -> 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<T> PartialOrd for Probability<T>

where T: PartialOrd + FloatBounds,

fn partial_cmp(&self, other: &Probability<T>) -> 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<T> Copy for Probability<T>

where T: Copy + FloatBounds,

impl<T> StructuralPartialEq for Probability<T>

where T: FloatBounds,