Struct statrs::distribution::Multinomial [−][src]
pub struct Multinomial { /* fields omitted */ }
Expand description
Implements the Multinomial distribution which is a generalization of the Binomial distribution
Examples
use statrs::distribution::Multinomial; use statrs::statistics::MeanN; use nalgebra::DVector; let n = Multinomial::new(&[0.3, 0.7], 5).unwrap(); assert_eq!(n.mean().unwrap(), DVector::from_vec(vec![1.5, 3.5]));
Implementations
impl Multinomial
[src]
impl Multinomial
[src]pub fn new(p: &[f64], n: u64) -> Result<Multinomial>
[src]
pub fn new(p: &[f64], n: u64) -> Result<Multinomial>
[src]Constructs a new multinomial distribution with probabilities p
and n
number of trials.
Errors
Returns an error if p
is empty, the sum of the elements
in p
is 0, or any element in p
is less than 0 or is f64::NAN
Note
The elements in p
do not need to be normalized
Examples
use statrs::distribution::Multinomial; let mut result = Multinomial::new(&[0.0, 1.0, 2.0], 3); assert!(result.is_ok()); result = Multinomial::new(&[0.0, -1.0, 2.0], 3); assert!(result.is_err());
Trait Implementations
impl Clone for Multinomial
[src]
impl Clone for Multinomial
[src]fn clone(&self) -> Multinomial
[src]
fn clone(&self) -> Multinomial
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl Debug for Multinomial
[src]
impl Debug for Multinomial
[src]impl<'a> Discrete<&'a [u64], f64> for Multinomial
[src]
impl<'a> Discrete<&'a [u64], f64> for Multinomial
[src]fn pmf(&self, x: &[u64]) -> f64
[src]
fn pmf(&self, x: &[u64]) -> f64
[src]Calculates the probability mass function for the multinomial
distribution
with the given x
’s corresponding to the probabilities for this
distribution
Panics
If the elements in x
do not sum to n
or if the length of x
is not
equivalent to the length of p
Formula
(n! / x_1!...x_k!) * p_i^x_i for i in 1...k
where n
is the number of trials, p_i
is the i
th probability,
x_i
is the i
th x
value, and k
is the total number of
probabilities
fn ln_pmf(&self, x: &[u64]) -> f64
[src]
fn ln_pmf(&self, x: &[u64]) -> f64
[src]Calculates the log probability mass function for the multinomial
distribution
with the given x
’s corresponding to the probabilities for this
distribution
Panics
If the elements in x
do not sum to n
or if the length of x
is not
equivalent to the length of p
Formula
ln((n! / x_1!...x_k!) * p_i^x_i) for i in 1...k
where n
is the number of trials, p_i
is the i
th probability,
x_i
is the i
th x
value, and k
is the total number of
probabilities
impl Distribution<Vec<f64, Global>> for Multinomial
[src]
impl Distribution<Vec<f64, Global>> for Multinomial
[src]fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> Vec<f64>
[src]
fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> Vec<f64>
[src]Generate a random value of T
, using rng
as the source of randomness.
fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T> where
R: Rng,
[src]
fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T> where
R: Rng,
[src]Create an iterator that generates random values of T
, using rng
as
the source of randomness. Read more
impl MeanN<Matrix<f64, Dynamic, Const<1_usize>, VecStorage<f64, Dynamic, Const<1_usize>>>> for Multinomial
[src]
impl MeanN<Matrix<f64, Dynamic, Const<1_usize>, VecStorage<f64, Dynamic, Const<1_usize>>>> for Multinomial
[src]impl PartialEq<Multinomial> for Multinomial
[src]
impl PartialEq<Multinomial> for Multinomial
[src]fn eq(&self, other: &Multinomial) -> bool
[src]
fn eq(&self, other: &Multinomial) -> bool
[src]This method tests for self
and other
values to be equal, and is used
by ==
. Read more
fn ne(&self, other: &Multinomial) -> bool
[src]
fn ne(&self, other: &Multinomial) -> bool
[src]This method tests for !=
.
impl VarianceN<Matrix<f64, Dynamic, Dynamic, VecStorage<f64, Dynamic, Dynamic>>> for Multinomial
[src]
impl VarianceN<Matrix<f64, Dynamic, Dynamic, VecStorage<f64, Dynamic, Dynamic>>> for Multinomial
[src]impl StructuralPartialEq for Multinomial
[src]
Auto Trait Implementations
impl RefUnwindSafe for Multinomial
impl Send for Multinomial
impl Sync for Multinomial
impl Unpin for Multinomial
impl UnwindSafe for Multinomial
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
type Output = T
Should always be Self
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
pub fn to_subset(&self) -> Option<SS>
pub fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
pub fn is_in_subset(&self) -> bool
pub fn is_in_subset(&self) -> bool
Checks if self
is actually part of its subset T
(and can be converted to it).
pub fn to_subset_unchecked(&self) -> SS
pub fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
pub fn from_subset(element: &SS) -> SP
pub fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,