Struct rv::dist::StudentsT

pub struct StudentsT { /* fields omitted */ }

Student’s T distribution over x in (-∞, ∞).

Implementations

impl StudentsT

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

Create a new Student’s T distribtuion with degrees of freedom, v.

pub fn new_unchecked(v: f64) -> Self

Creates a new StudentsT without checking whether the parameter is valid.

pub fn v(&self) -> f64

Get the degrees of freedom, v

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

Set the value of v

Example

use rv::dist::StudentsT;

let mut t = StudentsT::new(1.2).unwrap();
assert_eq!(t.v(), 1.2);

t.set_v(4.3).unwrap();
assert_eq!(t.v(), 4.3);

Will error for invalid values

assert!(t.set_v(2.1).is_ok());

// must be greater than zero
assert!(t.set_v(0.0).is_err());
assert!(t.set_v(-1.0).is_err());


assert!(t.set_v(std::f64::INFINITY).is_err());
assert!(t.set_v(std::f64::NEG_INFINITY).is_err());
assert!(t.set_v(std::f64::NAN).is_err());

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

Set the value of v without input validation

Trait Implementations

impl Clone for StudentsT

fn clone(&self) -> StudentsT

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ContinuousDistr<f32> for StudentsT

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 StudentsT

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 StudentsT

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

Formats the value using the given formatter.

impl Default for StudentsT

fn default() -> Self

Returns the “default value” for a type.

impl Display for StudentsT

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

Formats the value using the given formatter.

impl Kurtosis for StudentsT

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

impl Mean<f32> for StudentsT

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

Returns None if the mean is undefined

impl Mean<f64> for StudentsT

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

Returns None if the mean is undefined

impl Median<f32> for StudentsT

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

Returns None if the median is undefined

impl Median<f64> for StudentsT

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

Returns None if the median is undefined

impl Mode<f32> for StudentsT

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

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

impl Mode<f64> for StudentsT

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

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

impl PartialEq<StudentsT> for StudentsT

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

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

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

This method tests for !=.

impl Rv<f32> for StudentsT

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 StudentsT

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 StudentsT

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

impl StructuralPartialEq for StudentsT

impl Support<f32> for StudentsT

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

Returns true if x is in the support of the Rv

impl Support<f64> for StudentsT

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

Returns true if x is in the support of the Rv

impl Variance<f32> for StudentsT

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

Returns None if the variance is undefined

impl Variance<f64> for StudentsT

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

Returns None if the variance is undefined