Struct ndarray_rand::rand_distr::Dirichlet[−][src]

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 for Dirichlet<F> where F: Clone + Float, StandardNormal: Distribution<F>, Exp1: Distribution<F>, Open01: Distribution<F>,` [src]

`pub fn clone(&self) -> Dirichlet<F>`[src]

`pub fn clone_from(&mut self, source: &Self)`1.0.0[src]

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

`pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src]

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

`pub fn sample<R>(&self, rng: &mut R) -> Vec<F, Global> where R: Rng + ?Sized,` [src]

`pub fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>ⓘNotable traits for DistIter<D, R, T> impl<D, R, T> Iterator for DistIter<D, R, T> where D: Distribution<T>, R: Rng, type Item = T; where R: Rng,` [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]

`pub fn type_id(&self) -> TypeId`[src]

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

`pub fn borrow(&self) -> &T`[src]

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

`pub fn borrow_mut(&mut self) -> &mut T`[src]

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

`pub fn from(t: T) -> T`[src]

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

`pub fn into(self) -> U`[src]

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

`type Owned = T`

The resulting type after obtaining ownership.

`pub fn to_owned(&self) -> T`[src]

`pub fn clone_into(&self, target: &mut T)`[src]

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

`type Error = Infallible`

The type returned in the event of a conversion error.

`pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

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

`type Error = >::Error`

The type returned in the event of a conversion error.

`pub fn try_into(self) -> Result<U, >::Error>`[src]

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

`pub fn vzip(self) -> V`

Struct ndarray_rand::rand_distr::Dirichlet[−][src]

Example

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]

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

Trait Implementations

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

pub fn clone(&self) -> Dirichlet<F>[src]

pub fn clone_from(&mut self, source: &Self)1.0.0[src]

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

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[src]

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

pub fn sample<R>(&self, rng: &mut R) -> Vec<F, Global> where R: Rng + ?Sized, [src]

pub fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>ⓘNotable traits for DistIter<D, R, T>impl<D, R, T> Iterator for DistIter<D, R, T> where D: Distribution<T>, R: Rng, type Item = T; where R: Rng, [src]

Notable traits for DistIter<D, R, T>

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]

pub fn type_id(&self) -> TypeId[src]

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

pub fn borrow(&self) -> &T[src]

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

pub fn borrow_mut(&mut self) -> &mut T[src]

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

pub fn from(t: T) -> T[src]

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

pub fn into(self) -> U[src]

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

type Owned = T

pub fn to_owned(&self) -> T[src]

pub fn clone_into(&self, target: &mut T)[src]

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

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

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

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

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

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

pub fn vzip(self) -> V