[−][src]Struct rv::dist::VonMises
VonMises distirbution on the circular interval (0, 2π]
Example
use rv::prelude::*; let vm = VonMises::new(1.0, 2.0).unwrap(); // x is in (0, 2π] assert!(!vm.supports(&-0.001_f64)); assert!(!vm.supports(&6.3_f64)); // 103 VonMises draws let mut rng = rand::thread_rng(); let xs: Vec<f64> = vm.sample(103, &mut rng); assert_eq!(xs.len(), 103);
Implementations
impl VonMises
[src]
pub fn new(mu: f64, k: f64) -> Result<Self, VonMisesError>
[src]
Create a new VonMises distribution with mean mu, and precision, k.
pub fn new_unchecked(mu: f64, k: f64) -> Self
[src]
Creates a new VonMises without checking whether the parameters are valid.
pub fn mu(&self) -> f64
[src]
Get the mean parameter, mu
Example
let vm = VonMises::new(0.0, 1.0).unwrap(); assert_eq!(vm.mu(), 0.0);
pub fn set_mu(&mut self, mu: f64) -> Result<(), VonMisesError>
[src]
Set the value of mu
Example
use rv::dist::VonMises; let mut vm = VonMises::new(2.0, 1.5).unwrap(); assert_eq!(vm.mu(), 2.0); vm.set_mu(1.3).unwrap(); assert_eq!(vm.mu(), 1.3);
Will error for invalid values
assert!(vm.set_mu(1.3).is_ok()); assert!(vm.set_mu(0.0).is_ok()); assert!(vm.set_mu(2.0 * std::f64::consts::PI).is_ok()); assert!(vm.set_mu(0.0 - 0.001).is_err()); assert!(vm.set_mu(2.0 * std::f64::consts::PI + 0.001).is_err()); assert!(vm.set_mu(std::f64::NEG_INFINITY).is_err()); assert!(vm.set_mu(std::f64::INFINITY).is_err()); assert!(vm.set_mu(std::f64::NAN).is_err());
pub fn set_mu_unchecked(&mut self, mu: f64)
[src]
Set the value of mu without input validation
pub fn k(&self) -> f64
[src]
Get the precision parameter, k
Example
let vm = VonMises::new(0.0, 1.0).unwrap(); assert_eq!(vm.k(), 1.0);
pub fn set_k(&mut self, k: f64) -> Result<(), VonMisesError>
[src]
Set the value of k
Example
let mut vm = VonMises::new(0.0, 1.0).unwrap(); let v1: f64 = vm.variance().unwrap(); assert::close(v1, 0.5536100341034653, 1E-10); vm.set_mu(0.2); vm.set_k(2.0); let v2: f64 = vm.variance().unwrap(); assert::close(v2, 0.3022253420359917, 1E-10);
Will error for invalid values
assert!(vm.set_k(0.1).is_ok()); // Must be greater than zero assert!(vm.set_k(0.0).is_err()); assert!(vm.set_k(-1.0).is_err()); assert!(vm.set_k(std::f64::INFINITY).is_err()); assert!(vm.set_k(std::f64::NEG_INFINITY).is_err()); assert!(vm.set_k(std::f64::NAN).is_err());
pub fn set_k_unchecked(&mut self, k: f64)
[src]
Set the value of k without input validation
Trait Implementations
impl Cdf<f32> for VonMises
[src]
impl Cdf<f64> for VonMises
[src]
impl Clone for VonMises
[src]
impl ContinuousDistr<f32> for VonMises
[src]
impl ContinuousDistr<f64> for VonMises
[src]
impl Debug for VonMises
[src]
impl Default for VonMises
[src]
impl Display for VonMises
[src]
impl Entropy for VonMises
[src]
impl<'_> From<&'_ VonMises> for String
[src]
impl Mean<f32> for VonMises
[src]
impl Mean<f64> for VonMises
[src]
impl Median<f32> for VonMises
[src]
impl Median<f64> for VonMises
[src]
impl Mode<f32> for VonMises
[src]
impl Mode<f64> for VonMises
[src]
impl PartialEq<VonMises> for VonMises
[src]
impl Rv<f32> for VonMises
[src]
fn ln_f(&self, x: &f32) -> f64
[src]
fn draw<R: Rng>(&self, rng: &mut R) -> f32
[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<f64> for VonMises
[src]
fn ln_f(&self, x: &f64) -> f64
[src]
fn draw<R: Rng>(&self, rng: &mut R) -> 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 VonMises
[src]
impl Support<f32> for VonMises
[src]
impl Support<f64> for VonMises
[src]
impl Variance<f32> for VonMises
[src]
impl Variance<f64> for VonMises
[src]
Auto Trait Implementations
impl RefUnwindSafe for VonMises
impl Send for VonMises
impl Sync for VonMises
impl Unpin for VonMises
impl UnwindSafe for VonMises
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> Cdf<X> for Fx where
Fx: Deref,
<Fx as Deref>::Target: Cdf<X>,
[src]
Fx: Deref,
<Fx as Deref>::Target: Cdf<X>,
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<Fx> Entropy for Fx where
Fx: Deref,
<Fx as Deref>::Target: Entropy,
[src]
Fx: Deref,
<Fx as Deref>::Target: Entropy,
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> Mean<X> for Fx where
Fx: Deref,
<Fx as Deref>::Target: Mean<X>,
[src]
Fx: Deref,
<Fx as Deref>::Target: Mean<X>,
impl<Fx, X> Median<X> for Fx where
Fx: Deref,
<Fx as Deref>::Target: Median<X>,
[src]
Fx: Deref,
<Fx as Deref>::Target: Median<X>,
impl<Fx, X> Mode<X> for Fx where
Fx: Deref,
<Fx as Deref>::Target: Mode<X>,
[src]
Fx: Deref,
<Fx as Deref>::Target: Mode<X>,
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>,
fn vzip(self) -> V
impl<Fx, X> Variance<X> for Fx where
Fx: Deref,
<Fx as Deref>::Target: Variance<X>,
[src]
Fx: Deref,
<Fx as Deref>::Target: Variance<X>,