Struct rstat::univariate::folded_normal::FoldedNormal

pub struct FoldedNormal(_);

Methods

impl FoldedNormal

pub fn new(mu: f64, sigma: f64) -> Result<FoldedNormal, Error>

pub fn new_unchecked(mu: f64, sigma: f64) -> FoldedNormal

pub fn half_normal(scale: Scale<f64>) -> FoldedNormal

pub fn standard() -> FoldedNormal

pub fn precision(&self) -> f64

Trait Implementations

impl Clone for FoldedNormal

fn clone(&self) -> FoldedNormal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ContinuousDistribution for FoldedNormal

fn pdf(&self, x: &f64) -> f64

Evaluates the probability density function (PDF) at (x).

fn log_pdf(&self, x: &Sample<Self>) -> f64

Evaluates the log PDF at (x).

impl Copy for FoldedNormal

impl Debug for FoldedNormal

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

Formats the value using the given formatter.

impl Default for FoldedNormal

fn default() -> FoldedNormal

Returns the "default value" for a type.

impl Display for FoldedNormal

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

Formats the value using the given formatter.

impl Distribution for FoldedNormal

type Support = NonNegativeReals

Support of sample elements.

type Params = Params

Parameter set uniquely defining the instance.

fn support(&self) -> NonNegativeReals

Returns an instance of the support Space, Self::Support.

fn params(&self) -> Params

Returns an instance of Self::Params matching the parameters of self.

fn cdf(&self, x: &f64) -> Probability

Evaluates the cumulative distribution function (CDF) at (x).

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> f64

Draw a random value from the distribution support.

fn into_support(self) -> Self::Support

fn into_params(self) -> Self::Params

fn ccdf(&self, x: &Sample<Self>) -> Probability

Evaluates the complementary CDF at (x).

fn log_cdf(&self, x: &Sample<Self>) -> f64

Evaluates the log CDF at (x), i.e. (\ln{F(x)}).

fn log_ccdf(&self, x: &Sample<Self>) -> f64

Evaluates the log complementary CDF at (x), i.e. (\ln{(1 - F(x))}).

fn sample_n<R: Rng + ?Sized>(&self, rng: &mut R, n: usize) -> Vec<Sample<Self>>

Draw n random value from the distribution support.

fn sample_iter<'a, R: Rng + ?Sized>(
    &'a self,
    rng: &'a mut R
) -> Sampler<'a, Self, R>

Draw an indefinite number of random values from the distribution support.

impl From<Params> for FoldedNormal

fn from(from: Params) -> FoldedNormal

Performs the conversion.

impl Modes for FoldedNormal

fn modes(&self) -> Vec<f64>

Computes the mode(s) of the distribution.

impl UnivariateMoments for FoldedNormal

fn mean(&self) -> f64

Computes the expected value of the distribution.

fn variance(&self) -> f64

Computes the variance of the distribution.

fn skewness(&self) -> f64

Computes the skewness of the distribution.

fn kurtosis(&self) -> f64

Computes the kurtosis of the distribution.

fn excess_kurtosis(&self) -> f64

Computes the excess kurtosis of the distribution.

fn standard_deviation(&self) -> f64

Computes the standard deviation of the distribution.