Struct rv::dist::ScaledInvChiSquared

pub struct ScaledInvChiSquared { /* fields omitted */ }

Scaled Χ^-2 distribution Scaled-Χ^-2(v, τ²).

Example

use rv::prelude::*;

let ix2 = ScaledInvChiSquared::new(2.0, 1.0).unwrap();

Implementations

impl ScaledInvChiSquared

pub fn new(v: f64, t2: f64) -> Result<Self, ScaledInvChiSquaredError>

Create a new Inverse Chi-squared distribution

Arguments

• v: Degrees of freedom in (0, ∞)
• t2: Scale factor in (0, ∞)

pub fn new_unchecked(v: f64, t2: f64) -> Self

Create a new ScaledInvChiSquared without checking whether the parameters are valid.

pub fn v(&self) -> f64

Get the degrees of freedom, v.

Example

let ix2 = ScaledInvChiSquared::new(1.2, 3.4).unwrap();
assert_eq!(ix2.v(), 1.2);

pub fn set_v(&mut self, v: f64) -> Result<(), ScaledInvChiSquaredError>

Set the degrees of freedom, k.

Example

let mut ix2 = ScaledInvChiSquared::new(1.2, 3.4).unwrap();

ix2.set_v(2.2).unwrap();
assert_eq!(ix2.v(), 2.2);

Will error given invalid values.

assert!(ix2.set_v(2.2).is_ok());
assert!(ix2.set_v(0.0).is_err());
assert!(ix2.set_v(-1.0).is_err());
assert!(ix2.set_v(std::f64::NAN).is_err());
assert!(ix2.set_v(std::f64::INFINITY).is_err());

pub fn set_v_unchecked(&mut self, v: f64)

pub fn t2(&self) -> f64

Get the scale factor t2.

Example

let ix2 = ScaledInvChiSquared::new(1.2, 3.4).unwrap();
assert_eq!(ix2.t2(), 3.4);

pub fn set_t2(&mut self, t2: f64) -> Result<(), ScaledInvChiSquaredError>

Set the scale factor t2

Example

let mut ix2 = ScaledInvChiSquared::new(1.2, 3.4).unwrap();

ix2.set_t2(2.2).unwrap();
assert_eq!(ix2.t2(), 2.2);

Will error given invalid values.

assert!(ix2.set_t2(2.2).is_ok());
assert!(ix2.set_t2(0.0).is_err());
assert!(ix2.set_t2(-1.0).is_err());
assert!(ix2.set_t2(std::f64::NAN).is_err());
assert!(ix2.set_t2(std::f64::INFINITY).is_err());

pub fn set_t2_unchecked(&mut self, t2: f64)

Trait Implementations

impl Cdf<f32> for ScaledInvChiSquared

fn cdf(&self, x: &f32) -> f64

The value of the Cumulative Density Function at x

fn sf(&self, x: &X) -> f64

Survival function, 1 - CDF(x)

impl Cdf<f64> for ScaledInvChiSquared

fn cdf(&self, x: &f64) -> f64

The value of the Cumulative Density Function at x

fn sf(&self, x: &X) -> f64

Survival function, 1 - CDF(x)

impl Clone for ScaledInvChiSquared

fn clone(&self) -> Self

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ContinuousDistr<f32> for ScaledInvChiSquared

fn pdf(&self, x: &X) -> f64

The value of the Probability Density Function (PDF) at x

fn ln_pdf(&self, x: &X) -> f64

The value of the log Probability Density Function (PDF) at x

impl ContinuousDistr<f64> for ScaledInvChiSquared

fn pdf(&self, x: &X) -> f64

The value of the Probability Density Function (PDF) at x

fn ln_pdf(&self, x: &X) -> f64

The value of the log Probability Density Function (PDF) at x

impl Debug for ScaledInvChiSquared

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for ScaledInvChiSquared

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Kurtosis for ScaledInvChiSquared

fn kurtosis(&self) -> Option<f64>

impl Mean<f32> for ScaledInvChiSquared

fn mean(&self) -> Option<f32>

Returns None if the mean is undefined

impl Mean<f64> for ScaledInvChiSquared

fn mean(&self) -> Option<f64>

Returns None if the mean is undefined

impl Mode<f32> for ScaledInvChiSquared

fn mode(&self) -> Option<f32>

Returns None if the mode is undefined or is not a single value

impl Mode<f64> for ScaledInvChiSquared

fn mode(&self) -> Option<f64>

Returns None if the mode is undefined or is not a single value

impl PartialEq<ScaledInvChiSquared> for ScaledInvChiSquared

fn eq(&self, other: &ScaledInvChiSquared) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Rv<f32> for ScaledInvChiSquared

fn ln_f(&self, x: &f32) -> f64

Probability function

fn draw<R: Rng>(&self, rng: &mut R) -> f32

Single draw from the Rv

fn f(&self, x: &X) -> f64

Probability function

fn sample<R: Rng>(&self, n: usize, rng: &mut R) -> Vec<X>

Multiple draws of the Rv

fn sample_stream<'r, R: Rng>(
    &'r self,
    rng: &'r mut R
) -> Box<dyn Iterator<Item = X> + 'r>

Create a never-ending iterator of samples

impl Rv<f64> for ScaledInvChiSquared

fn ln_f(&self, x: &f64) -> f64

Probability function

fn draw<R: Rng>(&self, rng: &mut R) -> f64

Single draw from the Rv

fn f(&self, x: &X) -> f64

Probability function

fn sample<R: Rng>(&self, n: usize, rng: &mut R) -> Vec<X>

Multiple draws of the Rv

fn sample_stream<'r, R: Rng>(
    &'r self,
    rng: &'r mut R
) -> Box<dyn Iterator<Item = X> + 'r>

Create a never-ending iterator of samples

impl Skewness for ScaledInvChiSquared

fn skewness(&self) -> Option<f64>

impl Support<f32> for ScaledInvChiSquared

fn supports(&self, x: &f32) -> bool

Returns true if x is in the support of the Rv

impl Support<f64> for ScaledInvChiSquared

fn supports(&self, x: &f64) -> bool

Returns true if x is in the support of the Rv

impl Variance<f32> for ScaledInvChiSquared

fn variance(&self) -> Option<f32>

Returns None if the variance is undefined

impl Variance<f64> for ScaledInvChiSquared

fn variance(&self) -> Option<f64>

Returns None if the variance is undefined