[][src]Struct rand::distributions::Dirichlet

pub struct Dirichlet { /* fields omitted */ }

The dirichelet 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::distributions::Dirichlet;

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

Methods

impl Dirichlet[src]

pub fn new<V: Into<Vec<f64>>>(alpha: V) -> Dirichlet[src]

Construct a new Dirichlet with the given alpha parameter alpha.

Panics

  • if alpha.len() < 2

pub fn new_with_param(alpha: f64, size: usize) -> Dirichlet[src]

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

Panics

  • if alpha <= 0.0
  • if size < 2

Trait Implementations

impl Distribution<Vec<f64>> for Dirichlet[src]

impl Clone for Dirichlet[src]

impl Debug for Dirichlet[src]

Auto Trait Implementations

impl Send for Dirichlet

impl Unpin for Dirichlet

impl Sync for Dirichlet

impl UnwindSafe for Dirichlet

impl RefUnwindSafe for Dirichlet

Blanket Implementations

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

type Owned = T

The resulting type after obtaining ownership.

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

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

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<T> BorrowMut<T> for T where
    T: ?Sized
[src]

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

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