Struct statrs::distribution::Laplace

source · [−]
pub struct Laplace { /* private fields */ }
Expand description

Implements the Laplace distribution.

Examples

use statrs::distribution::{Laplace, Continuous};
use statrs::statistics::Mode;

let n = Laplace::new(0.0, 1.0).unwrap();
assert_eq!(n.mode().unwrap(), 0.0);
assert_eq!(n.pdf(1.0), 0.18393972058572117);

Implementations

Constructs a new laplace distribution with the given location and scale.

Errors

Returns an error if location or scale are NaN or scale <= 0.0

Examples
use statrs::distribution::Laplace;

let mut result = Laplace::new(0.0, 1.0);
assert!(result.is_ok());

result = Laplace::new(0.0, -1.0);
assert!(result.is_err());

Returns the location of the laplace distribution

Examples
use statrs::distribution::Laplace;

let n = Laplace::new(0.0, 1.0).unwrap();
assert_eq!(n.location(), 0.0);

Returns the scale of the laplace distribution

Examples
use statrs::distribution::Laplace;

let n = Laplace::new(0.0, 1.0).unwrap();
assert_eq!(n.scale(), 1.0);

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Calculates the probability density function for the laplace distribution at x

Formula
ⓘ
(1 / 2b) * exp(-|x - μ| / b)

where μ is the location and b is the scale

Calculates the log probability density function for the laplace distribution at x

Formula
ⓘ
ln((1 / 2b) * exp(-|x - μ| / b))

where μ is the location and b is the scale

Calculates the cumulative distribution function for the laplace distribution at x

Formula
ⓘ
(1 / 2) * (1 + signum(x - μ)) - signum(x - μ) * exp(-|x - μ| / b)

where μ is the location, b is the scale

Calculates the survival function for the laplace distribution at x

Formula
ⓘ
1 - [(1 / 2) * (1 + signum(x - μ)) - signum(x - μ) * exp(-|x - μ| / b)]

where μ is the location, b is the scale

Calculates the inverse cumulative distribution function for the laplace distribution at p

Formula

if p <= 1/2

ⓘ
μ + b * ln(2p)

if p >= 1/2

ⓘ
μ - b * ln(2 - 2p)

where μ is the location, b is the scale

Formats the value using the given formatter. Read more

Generate a random value of T, using rng as the source of randomness.

Create an iterator that generates random values of T, using rng as the source of randomness. Read more

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F Read more

Returns the mode of the laplace distribution

Formula
ⓘ
μ

where μ is the location

Returns the variance of the laplace distribution

Formula
ⓘ
2*b^2

where b is the scale

Returns the entropy of the laplace distribution

Formula
ⓘ
ln(2be)

where b is the scale

Returns the skewness of the laplace distribution

Formula
ⓘ
0

Returns the standard deviation, if it exists. Read more

Returns the maximum value in the domain of the laplace distribution representable by a double precision float

Formula
ⓘ
INF

Returns the median of the laplace distribution

Formula
ⓘ
μ

where μ is the location

Returns the minimum value in the domain of the laplace distribution representable by a double precision float

Formula
ⓘ
NEG_INF

Returns the mode of the laplace distribution

Formula
ⓘ
μ

where μ is the location

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

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

Should always be Self

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

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

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

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

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.