Struct statrs::distribution::Categorical [−][src]
pub struct Categorical { /* fields omitted */ }
Expand description
Implements the Categorical distribution, also known as the generalized Bernoulli or discrete distribution
Examples
use statrs::distribution::{Categorical, Discrete}; use statrs::statistics::Distribution; use statrs::prec; let n = Categorical::new(&[0.0, 1.0, 2.0]).unwrap(); assert!(prec::almost_eq(n.mean().unwrap(), 5.0 / 3.0, 1e-15)); assert_eq!(n.pmf(1), 1.0 / 3.0);
Implementations
impl Categorical
[src]
impl Categorical
[src]pub fn new(prob_mass: &[f64]) -> Result<Categorical>
[src]
pub fn new(prob_mass: &[f64]) -> Result<Categorical>
[src]Constructs a new categorical distribution
with the probabilities masses defined by prob_mass
Errors
Returns an error if prob_mass
is empty, the sum of
the elements in prob_mass
is 0, or any element is less than
0 or is f64::NAN
Note
The elements in prob_mass
do not need to be normalized
Examples
use statrs::distribution::Categorical; let mut result = Categorical::new(&[0.0, 1.0, 2.0]); assert!(result.is_ok()); result = Categorical::new(&[0.0, -1.0, 2.0]); assert!(result.is_err());
Trait Implementations
impl Clone for Categorical
[src]
impl Clone for Categorical
[src]fn clone(&self) -> Categorical
[src]
fn clone(&self) -> Categorical
[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 Categorical
[src]
impl Debug for Categorical
[src]impl Discrete<u64, f64> for Categorical
[src]
impl Discrete<u64, f64> for Categorical
[src]impl DiscreteCDF<u64, f64> for Categorical
[src]
impl DiscreteCDF<u64, f64> for Categorical
[src]impl Distribution<f64> for Categorical
[src]
impl Distribution<f64> for Categorical
[src]fn mean(&self) -> Option<f64>
[src]
fn mean(&self) -> Option<f64>
[src]Returns the mean of the categorical distribution
Formula
Σ(j * p_j)
where p_j
is the j
th probability mass,
Σ
is the sum from 0
to k - 1
,
and k
is the number of categories
fn variance(&self) -> Option<f64>
[src]
fn variance(&self) -> Option<f64>
[src]Returns the variance of the categorical distribution
Formula
Σ(p_j * (j - μ)^2)
where p_j
is the j
th probability mass, μ
is the mean,
Σ
is the sum from 0
to k - 1
,
and k
is the number of categories
impl Distribution<f64> for Categorical
[src]
impl Distribution<f64> for Categorical
[src]fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> f64
[src]
fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> 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 Max<u64> for Categorical
[src]
impl Max<u64> for Categorical
[src]impl Median<f64> for Categorical
[src]
impl Median<f64> for Categorical
[src]impl Min<u64> for Categorical
[src]
impl Min<u64> for Categorical
[src]impl PartialEq<Categorical> for Categorical
[src]
impl PartialEq<Categorical> for Categorical
[src]fn eq(&self, other: &Categorical) -> bool
[src]
fn eq(&self, other: &Categorical) -> bool
[src]This method tests for self
and other
values to be equal, and is used
by ==
. Read more
fn ne(&self, other: &Categorical) -> bool
[src]
fn ne(&self, other: &Categorical) -> bool
[src]This method tests for !=
.
impl StructuralPartialEq for Categorical
[src]
Auto Trait Implementations
impl RefUnwindSafe for Categorical
impl Send for Categorical
impl Sync for Categorical
impl Unpin for Categorical
impl UnwindSafe for Categorical
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>,