Struct statrs::distribution::Dirac [−][src]
pub struct Dirac(_);
Expand description
Implements the Dirac Delta distribution
Examples
use statrs::distribution::{Dirac, Continuous}; use statrs::statistics::Distribution; let n = Dirac::new(3.0).unwrap(); assert_eq!(n.mean().unwrap(), 3.0);
Implementations
Trait Implementations
Calculates the cumulative distribution function for the
dirac distribution at x
Where the value is 1 if x > v
, 0 otherwise.
Due to issues with rounding and floating-point accuracy the default
implementation may be ill-behaved.
Specialized inverse cdfs should be used whenever possible.
Performs a binary search on the domain of cdf
to obtain an approximation
of F^-1(p) := inf { x | F(x) >= p }
. Needless to say, performance may
may be lacking. Read more
Returns the mean of the dirac distribution
Remarks
Since the only value that can be produced by this distribution is v
with probability
1, it is just v
.
Returns the variance of the dirac distribution
Formula
0
Since only one value can be produced there is no variance.
Returns the entropy of the dirac distribution
Formula
0
Since this distribution has full certainty, it encodes no information
Generate a random value of T
, using rng
as the source of randomness.
Create an iterator that generates random values of T
, using rng
as
the source of randomness. Read more
Auto Trait Implementations
impl RefUnwindSafe for Dirac
impl UnwindSafe for Dirac
Blanket Implementations
Mutably borrows from an owned value. Read more
type Output = T
type Output = T
Should always be Self
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.
pub fn vzip(self) -> V