r_gen::distributions

Enum Distribution

pub enum Distribution {
    Bernoulli(f64),
    Binomial(i64, f64),
    Normal(f64, f64),
    Gamma(f64, f64),
    Beta(f64, f64),
    LogNormal(f64, f64),
    Categorical(Vec<f64>),
    Dirichlet(Vec<f64>),
}

Expand description

Enum that uniquely discribes a given distribution.

Variants§

Bernoulli(f64)

A Bernoulli distribution with paramater p.

Binomial(i64, f64)

A Binomial distribution with paramaters n and p.

Normal(f64, f64)

A Normal distribution with paramaters mu and sigma.

Gamma(f64, f64)

A Gamma distribution with parameters alpha and beta.

Beta(f64, f64)

A Beta distribution with parameters alpha and beta.

LogNormal(f64, f64)

A Lognormal distribution with paramaters mu and sigma.

Categorical(Vec<f64>)

A Categorical distribution with weights equal to p.

Dirichlet(Vec<f64>)

A Dirichlet distribution that returns a vector of degree n.

Trait Implementations§

impl Debug for Distribution

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

Formats the value using the given formatter. Read more

impl Sampleable for Distribution

fn sample(&self) -> Value

Sample from the distribution and return the value sampled.

fn liklihood(&self, value: &Value) -> Result<f64, &str>

Compute the liklihood of a value given a distribution (returns the log liklihood.)

§Errors

This function will return an Err if you try to determine the liklihood of a variant of the Value enum that the distribution does not produce. For example, trying to get the liklihood of a real number from a bernoulli distribution will return an Err.

Auto Trait Implementations§

impl Freeze for Distribution

impl RefUnwindSafe for Distribution

impl Send for Distribution

impl Sync for Distribution

impl Unpin for Distribution

impl UnwindSafe for Distribution

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

unsafe fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V