[−][src]Struct rv::dist::VonMises

pub struct VonMises { /* fields omitted */ }

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);

Methods

`impl VonMises`[src]

`pub fn set_mu(&mut self, val: f64) -> &mut Self`[src]

Mean

`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 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);

Trait Implementations

`impl Cdf<f32> for VonMises`[src]

`fn cdf(&self, x: &f32) -> f64`[src]

`fn sf(&self, x: &X) -> f64`[src]

`impl Cdf<f64> for VonMises`[src]

`fn cdf(&self, x: &f64) -> f64`[src]

`fn sf(&self, x: &X) -> f64`[src]

`impl Clone for VonMises`[src]

`fn clone(&self) -> VonMises`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl ContinuousDistr<f32> for VonMises`[src]

`fn pdf(&self, x: &X) -> f64`[src]

`fn ln_pdf(&self, x: &X) -> f64`[src]

`impl ContinuousDistr<f64> for VonMises`[src]

`fn pdf(&self, x: &X) -> f64`[src]

`fn ln_pdf(&self, x: &X) -> f64`[src]

`impl Debug for VonMises`[src]

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

`impl Default for VonMises`[src]

`fn default() -> Self`[src]

`impl Display for VonMises`[src]

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

`impl Entropy for VonMises`[src]

`fn entropy(&self) -> f64`[src]

`impl<'_> From<&'_ VonMises> for String`[src]

`fn from(vm: &VonMises) -> String`[src]

`impl Mean<f32> for VonMises`[src]

`fn mean(&self) -> Option<f32>`[src]

`impl Mean<f64> for VonMises`[src]

`fn mean(&self) -> Option<f64>`[src]

`impl Median<f32> for VonMises`[src]

`fn median(&self) -> Option<f32>`[src]

`impl Median<f64> for VonMises`[src]

`fn median(&self) -> Option<f64>`[src]

`impl Mode<f32> for VonMises`[src]

`fn mode(&self) -> Option<f32>`[src]

`impl Mode<f64> for VonMises`[src]

`fn mode(&self) -> Option<f64>`[src]

`impl PartialEq<VonMises> for VonMises`[src]

`fn eq(&self, other: &VonMises) -> bool`[src]

`fn ne(&self, other: &VonMises) -> bool`[src]

`impl PartialOrd<VonMises> for VonMises`[src]

`fn partial_cmp(&self, other: &VonMises) -> Option<Ordering>`[src]

`fn lt(&self, other: &VonMises) -> bool`[src]

`fn le(&self, other: &VonMises) -> bool`[src]

`fn gt(&self, other: &VonMises) -> bool`[src]

`fn ge(&self, other: &VonMises) -> bool`[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]

`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]

`impl StructuralPartialEq for VonMises`[src]

`impl Support<f32> for VonMises`[src]

`fn supports(&self, x: &f32) -> bool`[src]

`impl Support<f64> for VonMises`[src]

`fn supports(&self, x: &f64) -> bool`[src]

`impl Variance<f32> for VonMises`[src]

`fn variance(&self) -> Option<f32>`[src]

`impl Variance<f64> for VonMises`[src]

`fn variance(&self) -> Option<f64>`[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]

`fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`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]

`fn cdf(&Self, &X) -> f64`[src]

`fn sf(&Self, &X) -> f64`[src]

`impl<Fx, X> ContinuousDistr<X> for Fx where Fx: Deref, <Fx as Deref>::Target: ContinuousDistr<X>,` [src]

`fn pdf(&self, x: &X) -> f64`[src]

`fn ln_pdf(&self, x: &X) -> f64`[src]

`impl<Fx> Entropy for Fx where Fx: Deref, <Fx as Deref>::Target: Entropy,` [src]

`fn entropy(&Self) -> f64`[src]

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> Into<U> for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<Fx, X> Mean<X> for Fx where Fx: Deref, <Fx as Deref>::Target: Mean<X>,` [src]

`fn mean(&Self) -> Option<X>`[src]

`impl<Fx, X> Median<X> for Fx where Fx: Deref, <Fx as Deref>::Target: Median<X>,` [src]

`fn median(&Self) -> Option<X>`[src]

`impl<Fx, X> Mode<X> for Fx where Fx: Deref, <Fx as Deref>::Target: Mode<X>,` [src]

`fn mode(&Self) -> Option<X>`[src]

`impl<Fx, X> Rv<X> for Fx where Fx: Deref, <Fx as Deref>::Target: Rv<X>,` [src]

`fn ln_f(&Self, &X) -> f64`[src]

`fn f(&Self, &X) -> f64`[src]

`fn draw<R>(&Self, &mut R) -> X where R: Rng,` [src]

`fn sample<R>(&Self, usize, &mut R) -> Vec<X> where R: Rng,` [src]

`impl<T> Same<T> for T`

`type Output = T`

Should always be Self

`impl<SS, SP> SupersetOf<SS> for SP where 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]

`fn supports(&Self, &X) -> bool`[src]

`impl<T> ToOwned for T where T: Clone,` [src]

`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]

`default fn to_string(&self) -> String`[src]

`impl<T, U> TryFrom<U> for T where U: Into<T>,` [src]

`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]

`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>,`

`fn vzip(self) -> V`

`impl<Fx, X> Variance<X> for Fx where Fx: Deref, <Fx as Deref>::Target: Variance<X>,` [src]

`fn variance(&Self) -> Option<X>`[src]