# Struct rand_distr::NormalInverseGaussian

``````pub struct NormalInverseGaussian<F>where
F: Float,
StandardNormal: Distribution<F>,
Standard: Distribution<F>,{ /* private fields */ }``````
Expand description

The normal-inverse Gaussian distribution `NIG(α, β)`.

This is a continuous probability distribution with two parameters, `α` (`alpha`) and `β` (`beta`), defined in `(-∞, ∞)`. It is also known as the normal-Wald distribution.

## §Plot

The following plot shows the normal-inverse Gaussian distribution with various values of `α` and `β`.

## §Example

``````use rand_distr::{NormalInverseGaussian, Distribution};

let norm_inv_gauss = NormalInverseGaussian::new(2.0, 1.0).unwrap();
println!("{} is from a normal-inverse Gaussian(2, 1) distribution", v);``````

## Implementations§

source§

### impl<F> NormalInverseGaussian<F>where F: Float, StandardNormal: Distribution<F>, Standard: Distribution<F>,

source

#### pub fn new(alpha: F, beta: F) -> Result<NormalInverseGaussian<F>, Error>

Construct a new `NormalInverseGaussian` distribution with the given alpha (tail heaviness) and beta (asymmetry) parameters.

## Trait Implementations§

source§

### impl<F> Clone for NormalInverseGaussian<F>where F: Float + Clone, StandardNormal: Distribution<F>, Standard: Distribution<F>,

source§

#### fn clone(&self) -> NormalInverseGaussian<F>

Returns a copy 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<F> Debug for NormalInverseGaussian<F>where F: Float + Debug, StandardNormal: Distribution<F>, Standard: Distribution<F>,

source§

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

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

### impl<'de, F> Deserialize<'de> for NormalInverseGaussian<F>where F: Float + Deserialize<'de>, StandardNormal: Distribution<F>, Standard: Distribution<F>,

source§

#### fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

### impl<F> Distribution<F> for NormalInverseGaussian<F>where F: Float, StandardNormal: Distribution<F>, Standard: Distribution<F>,

source§

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

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

#### fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T> ⓘwhere R: Rng, Self: Sized,

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

#### fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>where F: Fn(T) -> S, Self: Sized,

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

### impl<F> PartialEq for NormalInverseGaussian<F>where F: Float + PartialEq, StandardNormal: Distribution<F>, Standard: Distribution<F>,

source§

#### fn eq(&self, other: &NormalInverseGaussian<F>) -> 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<F> Serialize for NormalInverseGaussian<F>where F: Float + Serialize, StandardNormal: Distribution<F>, Standard: Distribution<F>,

source§

#### fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

source§

§

§

§

§

§

§

## Blanket Implementations§

source§

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

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<T> Borrow<T> for Twhere T: ?Sized,

source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

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

Mutably borrows from an owned value. Read more
source§

### impl<T> CloneToUninit for Twhere T: Clone,

source§

#### unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dst`. 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 Twhere 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 Twhere 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 Twhere 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 Twhere 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.
source§

source§

source§