Skip to main content

Weibull

Struct Weibull 

Source
pub struct Weibull { /* private fields */ }
Expand description

Weibull distribution with shape k and scale λ: P(X > x) = exp(-(x/λ)^k), as SciPy’s weibull_min(c=k, scale=λ) and R’s dweibull(shape, scale).

Below shape 1 the tail is heavier than exponential (but every moment exists); above 1 it is lighter. Layer moments use the regularized incomplete gamma: with z = (u/λ)^k, E[X^j; X > u] = λ^j Γ(1 + j/k) Q(1 + j/k, z).

use prospicio_prob::{Distribution, Severity, Weibull};

// Shape 1 is the exponential.
let e = Weibull::new(1.0, 2.0).unwrap();
assert!((e.mean() - 2.0).abs() < 1e-14);
assert!((e.stop_loss(3.0) - 2.0 * (-1.5f64).exp()).abs() < 1e-14);

Implementations§

Source§

impl Weibull

Source

pub fn new(shape: f64, scale: f64) -> Result<Self>

Weibull with shape k > 0 and scale λ > 0.

Source

pub fn shape(&self) -> f64

Shape k.

Source

pub fn scale(&self) -> f64

Scale λ.

Trait Implementations§

Source§

impl Clone for Weibull

Source§

fn clone(&self) -> Weibull

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Weibull

Source§

impl Debug for Weibull

Source§

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

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

impl Distribution for Weibull

Source§

fn quantile(&self, p: f64) -> Result<f64>

λ (-ln(1 - p))^(1/k), with ln(1 - p) taken as ln_1p(-p).

Source§

fn mean(&self) -> f64

Expected value.
Source§

fn variance(&self) -> f64

Variance.
Source§

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

P(X <= x).
Source§

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

P(X > x). Representations with a direct form override the default 1 - cdf(x), which loses all precision far in the tail.
Source§

fn std_dev(&self) -> f64

Standard deviation.
Source§

fn sample(&self, rng: &mut StreamRng, n: usize) -> Vec<f64>

n draws from stream rng, by inverse transform unless the family overrides it (crate::Gamma draws by Marsaglia and Tsang). Read more
Source§

fn is_parallel_safe(&self) -> bool

Whether the distribution may be evaluated on several threads at once. True for every native family; false for a crate::Custom whose callbacks must stay on the calling thread (an R function), so the parallel simulations run single-threaded when they meet one.
Source§

impl From<Weibull> for Dist

Source§

fn from(d: Weibull) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Weibull

Source§

fn eq(&self, other: &Weibull) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Severity for Weibull

Source§

fn lev(&self, limit: f64) -> f64

E[min(X, u)] = λ Γ(1 + 1/k) P(1 + 1/k, z) + u e^(-z).

Source§

fn stop_loss(&self, retention: f64) -> f64

From the tail, so it does not cancel against the mean.

Source§

fn layer(&self, limit: f64, attachment: f64) -> f64

LEV differences below the mean, stop-loss differences above it.

Source§

fn layer_second_moment(&self, limit: f64, attachment: f64) -> f64

t_2(a) - t_2(b) - 2a (t_1(a) - t_1(b)) with b = a + limit.

Source§

fn layer_variance(&self, limit: f64, attachment: f64) -> f64

Variance of the loss to the layer limit xs attachment.
Source§

impl StructuralPartialEq for Weibull

Auto Trait Implementations§

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.
§

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

§

fn vzip(self) -> V