MaybeUncertain

Struct MaybeUncertain 

Source
pub struct MaybeUncertain<T: ProbabilisticType> { /* private fields */ }
Expand description

A first-class type representing a value that is probabilistically present or absent. If the value is present, its own value is uncertain.

Implementations§

Source§

impl MaybeUncertain<bool>

Source

pub fn from_uncertain(value: Uncertain<bool>) -> Self

Source

pub fn from_value(value: bool) -> Self

Creates a new MaybeUncertain from a value that is certainly present and has a certain value.

Source

pub fn always_none() -> Self

Creates a new MaybeUncertain that is certainly absent.

Source

pub fn from_bernoulli_and_uncertain( prob_some: f64, present_value_dist: Uncertain<bool>, ) -> Self

Creates a MaybeUncertain where presence is determined by a Bernoulli trial.

Source

pub fn sample(&self) -> Result<Option<bool>, UncertainError>

Samples the MaybeUncertain value, returning Some(bool) if present or None if absent.

Source

pub fn is_some(&self) -> Uncertain<bool>

Returns an Uncertain<bool> representing the probability of the value being present.

Source

pub fn is_none(&self) -> Uncertain<bool>

Returns an Uncertain<bool> representing the probability of the value being absent.

Source

pub fn lift_to_uncertain( &self, threshold_prob_some: f64, confidence_level: f64, epsilon: f64, max_samples: usize, ) -> Result<Uncertain<bool>, UncertainError>

Converts the MaybeUncertain<bool> to a standard Uncertain<bool>.

This acts as a gate, returning Ok(Uncertain<bool>) only if the statistical evidence for the value’s presence meets the specified threshold.

Source§

impl MaybeUncertain<f64>

Source

pub fn from_uncertain(value: Uncertain<f64>) -> Self

Creates a new MaybeUncertain from a value that is certainly present but uncertain in value.

Source

pub fn from_value(value: f64) -> Self

Creates a new MaybeUncertain from a value that is certainly present and has a certain value.

Source

pub fn always_none() -> Self

Creates a new MaybeUncertain that is certainly absent.

Source

pub fn from_bernoulli_and_uncertain( prob_some: f64, present_value_dist: Uncertain<f64>, ) -> Self

Creates a MaybeUncertain where presence is determined by a Bernoulli trial.

Source

pub fn sample(&self) -> Result<Option<f64>, UncertainError>

Samples the MaybeUncertain value, returning Some(f64) if present or None if absent.

Source

pub fn is_some(&self) -> Uncertain<bool>

Returns an Uncertain<bool> representing the probability of the value being present.

Source

pub fn is_none(&self) -> Uncertain<bool>

Returns an Uncertain<bool> representing the probability of the value being absent.

Source

pub fn lift_to_uncertain( &self, threshold_prob_some: f64, confidence_level: f64, epsilon: f64, max_samples: usize, ) -> Result<Uncertain<f64>, UncertainError>

Converts the MaybeUncertain<f64> to a standard Uncertain<f64>.

This acts as a gate, returning Ok(Uncertain<f64>) only if the statistical evidence for the value’s presence meets the specified threshold.

Trait Implementations§

Source§

impl Add for MaybeUncertain<f64>

Source§

type Output = MaybeUncertain<f64>

The resulting type after applying the + operator.
Source§

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

Performs the + operation. Read more
Source§

impl<T: Clone + ProbabilisticType> Clone for MaybeUncertain<T>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug + ProbabilisticType> Debug for MaybeUncertain<T>

Source§

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

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

impl Div for MaybeUncertain<f64>

Source§

type Output = MaybeUncertain<f64>

The resulting type after applying the / operator.
Source§

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

Performs the / operation. Read more
Source§

impl Mul for MaybeUncertain<f64>

Source§

type Output = MaybeUncertain<f64>

The resulting type after applying the * operator.
Source§

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

Performs the * operation. Read more
Source§

impl Neg for MaybeUncertain<f64>

Source§

type Output = MaybeUncertain<f64>

The resulting type after applying the - operator.
Source§

fn neg(self) -> Self::Output

Performs the unary - operation. Read more
Source§

impl<T: PartialEq + ProbabilisticType> PartialEq for MaybeUncertain<T>

Source§

fn eq(&self, other: &MaybeUncertain<T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Sub for MaybeUncertain<f64>

Source§

type Output = MaybeUncertain<f64>

The resulting type after applying the - operator.
Source§

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

Performs the - operation. Read more
Source§

impl<T: ProbabilisticType> StructuralPartialEq for MaybeUncertain<T>

Auto Trait Implementations§

§

impl<T> Freeze for MaybeUncertain<T>

§

impl<T> !RefUnwindSafe for MaybeUncertain<T>

§

impl<T> Send for MaybeUncertain<T>

§

impl<T> Sync for MaybeUncertain<T>

§

impl<T> Unpin for MaybeUncertain<T>
where T: Unpin,

§

impl<T> !UnwindSafe for MaybeUncertain<T>

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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.