[][src]Struct rand_distr::Dirichlet

pub struct Dirichlet<F> where
    F: Float,
    StandardNormal: Distribution<F>,
    Exp1: Distribution<F>,
    Open01: Distribution<F>, 
{ /* fields omitted */ }

The Dirichlet distribution Dirichlet(alpha).

The Dirichlet distribution is a family of continuous multivariate probability distributions parameterized by a vector alpha of positive reals. It is a multivariate generalization of the beta distribution.

Example

use rand::prelude::*;
use rand_distr::Dirichlet;

let dirichlet = Dirichlet::new(&[1.0, 2.0, 3.0]).unwrap();
let samples = dirichlet.sample(&mut rand::thread_rng());
println!("{:?} is from a Dirichlet([1.0, 2.0, 3.0]) distribution", samples);

Implementations

impl<F> Dirichlet<F> where
    F: Float,
    StandardNormal: Distribution<F>,
    Exp1: Distribution<F>,
    Open01: Distribution<F>, 
[src]

pub fn new(alpha: &[F]) -> Result<Dirichlet<F>, Error>[src]

Construct a new Dirichlet with the given alpha parameter alpha.

Requires alpha.len() >= 2.

pub fn new_with_size(alpha: F, size: usize) -> Result<Dirichlet<F>, Error>[src]

Construct a new Dirichlet with the given shape parameter alpha and size.

Requires size >= 2.

Trait Implementations

impl<F: Clone> Clone for Dirichlet<F> where
    F: Float,
    StandardNormal: Distribution<F>,
    Exp1: Distribution<F>,
    Open01: Distribution<F>, 
[src]

impl<F: Debug> Debug for Dirichlet<F> where
    F: Float,
    StandardNormal: Distribution<F>,
    Exp1: Distribution<F>,
    Open01: Distribution<F>, 
[src]

impl<F> Distribution<Vec<F>> for Dirichlet<F> where
    F: Float,
    StandardNormal: Distribution<F>,
    Exp1: Distribution<F>,
    Open01: Distribution<F>, 
[src]

Auto Trait Implementations

impl<F> RefUnwindSafe for Dirichlet<F> where
    F: RefUnwindSafe

impl<F> Send for Dirichlet<F> where
    F: Send

impl<F> Sync for Dirichlet<F> where
    F: Sync

impl<F> Unpin for Dirichlet<F>

impl<F> UnwindSafe for Dirichlet<F> where
    F: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

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