Struct rand_distr::Dirichlet

source ·
pub struct Dirichlet<F, const N: usize>{ /* private fields */ }
Available on crate feature alloc only.
Expand description

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§

source§

impl<F, const N: usize> Dirichlet<F, N>

source

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

Construct a new Dirichlet with the given alpha parameter alpha.

Requires alpha.len() >= 2, and each value in alpha must be positive, finite and not subnormal.

Trait Implementations§

source§

impl<F, const N: usize> Clone for Dirichlet<F, N>

source§

fn clone(&self) -> Dirichlet<F, N>

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, const N: usize> Debug for Dirichlet<F, N>

source§

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

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

impl<F, const N: usize> Distribution<[F; N]> for Dirichlet<F, N>

source§

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> [F; N]

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, const N: usize> PartialEq for Dirichlet<F, N>

source§

fn eq(&self, other: &Dirichlet<F, N>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<F, const N: usize> StructuralPartialEq for Dirichlet<F, N>

Auto Trait Implementations§

§

impl<F, const N: usize> RefUnwindSafe for Dirichlet<F, N>
where F: RefUnwindSafe,

§

impl<F, const N: usize> Send for Dirichlet<F, N>
where F: Send,

§

impl<F, const N: usize> Sync for Dirichlet<F, N>
where F: Sync,

§

impl<F, const N: usize> Unpin for Dirichlet<F, N>
where F: Unpin,

§

impl<F, const N: usize> UnwindSafe for Dirichlet<F, N>
where F: UnwindSafe,

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

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

Mutably borrows from an owned value. 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 T
where 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 T
where T: Clone,

§

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 T
where U: Into<T>,

§

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 T
where U: TryFrom<T>,

§

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§

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

source§

fn vzip(self) -> V