Struct sprs_rand::rand_distr::Dirichlet
source · [−]pub struct Dirichlet<N> { /* private fields */ }
Expand description
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_distr::Dirichlet;
let dirichlet = Dirichlet::new(vec![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
sourceimpl<N> Dirichlet<N> where
N: Float,
StandardNormal: Distribution<N>,
Exp1: Distribution<N>,
Open01: Distribution<N>,
impl<N> Dirichlet<N> where
N: Float,
StandardNormal: Distribution<N>,
Exp1: Distribution<N>,
Open01: Distribution<N>,
Trait Implementations
sourceimpl<N> Distribution<Vec<N, Global>> for Dirichlet<N> where
N: Float,
StandardNormal: Distribution<N>,
Exp1: Distribution<N>,
Open01: Distribution<N>,
impl<N> Distribution<Vec<N, Global>> for Dirichlet<N> where
N: Float,
StandardNormal: Distribution<N>,
Exp1: Distribution<N>,
Open01: Distribution<N>,
sourcefn sample<R>(&self, rng: &mut R) -> Vec<N, Global> where
R: Rng + ?Sized,
fn sample<R>(&self, rng: &mut R) -> Vec<N, Global> where
R: Rng + ?Sized,
Generate a random value of T
, using rng
as the source of randomness.
sourcefn 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,
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,
D: Distribution<T>,
R: Rng, type Item = T;
Create an iterator that generates random values of T
, using rng
as
the source of randomness. Read more
Auto Trait Implementations
impl<N> RefUnwindSafe for Dirichlet<N> where
N: RefUnwindSafe,
impl<N> Send for Dirichlet<N> where
N: Send,
impl<N> Sync for Dirichlet<N> where
N: Sync,
impl<N> Unpin for Dirichlet<N> where
N: Unpin,
impl<N> UnwindSafe for Dirichlet<N> where
N: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Pointable for T
impl<T> Pointable for T
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if self
is actually part of its subset T
(and can be converted to it).
unsafe fn to_subset_unchecked(&self) -> SS
unsafe fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.