[−][src]Struct rv::dist::SymmetricDirichlet
Symmetric Dirichlet distribution where all alphas are the same.
SymmetricDirichlet { alpha, k }
is mathematicall equivalent to
Dirichlet { alphas: vec![alpha; k] }
. This version has some extra
optimizations to seep up computing the PDF and drawing random vectors.
Implementations
impl SymmetricDirichlet
[src]
pub fn new(alpha: f64, k: usize) -> Result<Self, SymmetricDirichletError>
[src]
Create a new symmetric Dirichlet distributon
Arguments
- alpha: The Dirichlet weight.
- k : The number of weights.
alpha
will be replicatedk
times.
pub fn new_unchecked(alpha: f64, k: usize) -> Self
[src]
Create a new SymmetricDirichlet without checking whether the parmaeters are valid.
pub fn jeffreys(k: usize) -> Result<Self, SymmetricDirichletError>
[src]
The Jeffrey's Dirichlet prior for Categorical distributions
Example
let symdir = SymmetricDirichlet::jeffreys(4).unwrap(); assert_eq!(symdir, SymmetricDirichlet::new(0.5, 4).unwrap());
pub fn alpha(&self) -> f64
[src]
Get the alpha unfiorm weight parameter
Example
let symdir = SymmetricDirichlet::new(1.2, 5).unwrap(); assert_eq!(symdir.alpha(), 1.2);
pub fn set_alpha(&mut self, alpha: f64) -> Result<(), SymmetricDirichletError>
[src]
Set the value of alpha
Example
let mut symdir = SymmetricDirichlet::new(1.1, 5).unwrap(); assert_eq!(symdir.alpha(), 1.1); symdir.set_alpha(2.3).unwrap(); assert_eq!(symdir.alpha(), 2.3);
Will error for invalid parameters
assert!(symdir.set_alpha(0.5).is_ok()); assert!(symdir.set_alpha(0.0).is_err()); assert!(symdir.set_alpha(-1.0).is_err()); assert!(symdir.set_alpha(std::f64::INFINITY).is_err()); assert!(symdir.set_alpha(std::f64::NEG_INFINITY).is_err()); assert!(symdir.set_alpha(std::f64::NAN).is_err());
pub fn set_alpha_unchecked(&mut self, alpha: f64)
[src]
Set the value of alpha without input validation
pub fn k(&self) -> usize
[src]
Get the number of weights, k
Example
let symdir = SymmetricDirichlet::new(1.2, 5).unwrap(); assert_eq!(symdir.k(), 5);
Trait Implementations
impl Clone for SymmetricDirichlet
[src]
fn clone(&self) -> SymmetricDirichlet
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<X: CategoricalDatum> ConjugatePrior<X, Categorical> for SymmetricDirichlet
[src]
type Posterior = Dirichlet
fn posterior(&self, x: &CategoricalData<X>) -> Self::Posterior
[src]
fn ln_m(&self, x: &CategoricalData<X>) -> f64
[src]
fn ln_pp(&self, y: &X, x: &CategoricalData<X>) -> f64
[src]
fn m(&self, x: &DataOrSuffStat<X, Fx>) -> f64
[src]
fn pp(&self, y: &X, x: &DataOrSuffStat<X, Fx>) -> f64
[src]
impl ContinuousDistr<Vec<f64>> for SymmetricDirichlet
[src]
impl Debug for SymmetricDirichlet
[src]
impl Display for SymmetricDirichlet
[src]
impl<'_> From<&'_ SymmetricDirichlet> for String
[src]
fn from(symdir: &SymmetricDirichlet) -> String
[src]
impl<'_> From<&'_ SymmetricDirichlet> for Dirichlet
[src]
fn from(symdir: &SymmetricDirichlet) -> Self
[src]
impl From<SymmetricDirichlet> for Dirichlet
[src]
fn from(symdir: SymmetricDirichlet) -> Self
[src]
impl PartialEq<SymmetricDirichlet> for SymmetricDirichlet
[src]
fn eq(&self, other: &SymmetricDirichlet) -> bool
[src]
fn ne(&self, other: &SymmetricDirichlet) -> bool
[src]
impl PartialOrd<SymmetricDirichlet> for SymmetricDirichlet
[src]
fn partial_cmp(&self, other: &SymmetricDirichlet) -> Option<Ordering>
[src]
fn lt(&self, other: &SymmetricDirichlet) -> bool
[src]
fn le(&self, other: &SymmetricDirichlet) -> bool
[src]
fn gt(&self, other: &SymmetricDirichlet) -> bool
[src]
fn ge(&self, other: &SymmetricDirichlet) -> bool
[src]
impl Rv<Categorical> for SymmetricDirichlet
[src]
fn ln_f(&self, x: &Categorical) -> f64
[src]
fn draw<R: Rng>(&self, rng: &mut R) -> Categorical
[src]
fn f(&self, x: &X) -> f64
[src]
fn sample<R: Rng>(&self, n: usize, rng: &mut R) -> Vec<X>
[src]
fn sample_stream<'r, R: Rng>(
&'r self,
rng: &'r mut R
) -> Box<dyn Iterator<Item = X> + 'r>
[src]
&'r self,
rng: &'r mut R
) -> Box<dyn Iterator<Item = X> + 'r>
impl Rv<Vec<f64>> for SymmetricDirichlet
[src]
fn draw<R: Rng>(&self, rng: &mut R) -> Vec<f64>
[src]
fn ln_f(&self, x: &Vec<f64>) -> f64
[src]
fn f(&self, x: &X) -> f64
[src]
fn sample<R: Rng>(&self, n: usize, rng: &mut R) -> Vec<X>
[src]
fn sample_stream<'r, R: Rng>(
&'r self,
rng: &'r mut R
) -> Box<dyn Iterator<Item = X> + 'r>
[src]
&'r self,
rng: &'r mut R
) -> Box<dyn Iterator<Item = X> + 'r>
impl StructuralPartialEq for SymmetricDirichlet
[src]
impl Support<Vec<f64>> for SymmetricDirichlet
[src]
Auto Trait Implementations
impl RefUnwindSafe for SymmetricDirichlet
impl Send for SymmetricDirichlet
impl Sync for SymmetricDirichlet
impl Unpin for SymmetricDirichlet
impl UnwindSafe for SymmetricDirichlet
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<Fx, X> ContinuousDistr<X> for Fx where
Fx: Deref,
<Fx as Deref>::Target: ContinuousDistr<X>,
[src]
Fx: Deref,
<Fx as Deref>::Target: ContinuousDistr<X>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<Fx, X> Rv<X> for Fx where
Fx: Deref,
<Fx as Deref>::Target: Rv<X>,
[src]
Fx: Deref,
<Fx as Deref>::Target: Rv<X>,
fn ln_f(&Self, &X) -> f64
[src]
fn f(&Self, &X) -> f64
[src]
fn draw<R>(&Self, &mut R) -> X where
R: Rng,
[src]
R: Rng,
fn sample<R>(&Self, usize, &mut R) -> Vec<X> where
R: Rng,
[src]
R: Rng,
fn sample_stream<'r, R: Rng>(
&'r self,
rng: &'r mut R
) -> Box<dyn Iterator<Item = X> + 'r>
[src]
&'r self,
rng: &'r mut R
) -> Box<dyn Iterator<Item = X> + 'r>
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
SS: SubsetOf<SP>,
fn to_subset(&self) -> Option<SS>
fn is_in_subset(&self) -> bool
unsafe fn to_subset_unchecked(&self) -> SS
fn from_subset(element: &SS) -> SP
impl<Fx, X> Support<X> for Fx where
Fx: Deref,
<Fx as Deref>::Target: Support<X>,
[src]
Fx: Deref,
<Fx as Deref>::Target: Support<X>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,