Struct rv::dist::ChiSquared

pub struct ChiSquared { /* fields omitted */ }

Χ² distribution Χ²(k).

Example

use rv::prelude::*;

let x2 = ChiSquared::new(2.0).unwrap();

Implementations

impl ChiSquared

pub fn new(k: f64) -> Result<Self, ChiSquaredError>

Create a new Chi-squared distribution

Arguments

• k: Degrees of freedom in (0, ∞)

pub fn new_unchecked(k: f64) -> Self

Create a new ChiSquared wihout checking whether the parameters are valid.

pub fn k(&self) -> f64

Get the degrees of freedom, k.

Example

let x2 = ChiSquared::new(1.2).unwrap();
assert_eq!(x2.k(), 1.2);

pub fn set_k(&mut self, k: f64) -> Result<(), ChiSquaredError>

Get the degrees of freedom, k.

Example

let mut x2 = ChiSquared::new(1.2).unwrap();

x2.set_k(2.2).unwrap();
assert_eq!(x2.k(), 2.2);

Will error given invalid values.

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

pub fn set_k_unchecked(&mut self, k: f64)

Trait Implementations

impl Cdf<f32> for ChiSquared

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 ChiSquared

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 ChiSquared

fn clone(&self) -> ChiSquared

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ContinuousDistr<f32> for ChiSquared

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 ChiSquared

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 ChiSquared

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

Formats the value using the given formatter.

impl Display for ChiSquared

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

Formats the value using the given formatter.

impl<'_> From<&'_ ChiSquared> for String

fn from(x2: &ChiSquared) -> String

Performs the conversion.

impl Kurtosis for ChiSquared

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

impl Mean<f32> for ChiSquared

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

Returns None if the mean is undefined

impl Mean<f64> for ChiSquared

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

Returns None if the mean is undefined

impl Mode<f32> for ChiSquared

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

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

impl Mode<f64> for ChiSquared

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

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

impl PartialEq<ChiSquared> for ChiSquared

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

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

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

This method tests for !=.

impl Rv<f32> for ChiSquared

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

Probability function

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

Single draw from the Rv

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

Multiple draws of the Rv

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

Probability function

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 ChiSquared

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

Probability function

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

Single draw from the Rv

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

Multiple draws of the Rv

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

Probability function

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 ChiSquared

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

impl StructuralPartialEq for ChiSquared

impl Support<f32> for ChiSquared

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

Returns true if x is in the support of the Rv

impl Support<f64> for ChiSquared

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

Returns true if x is in the support of the Rv

impl Variance<f32> for ChiSquared

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

Returns None if the variance is undefined

impl Variance<f64> for ChiSquared

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

Returns None if the variance is undefined