Skip to main content

StudentT

Struct StudentT 

Source
pub struct StudentT { /* private fields */ }
Expand description

Student’s t-distribution with a location and scale, StudentT(ν, μ, σ).

Heavy-tailed generalization of the Normal; as ν → ∞ it converges to Normal(μ, σ). Widely used as a robust likelihood/prior because its tails tolerate outliers. ν need not be an integer.

Mathematical Properties:

  • Support: (-∞, +∞)
  • PDF: f(x) = Γ((ν+1)/2) / (Γ(ν/2)·√(νπ)·σ) · (1 + z²/ν)^(-(ν+1)/2), where z = (x−μ)/σ
  • Mean: μ for ν > 1 (undefined otherwise)
  • Variance: σ²·ν/(ν−2) for ν > 2 (infinite for 1 < ν ≤ 2)

Example:

// Robust prior with 3 degrees of freedom.
let robust = sample(addr!("theta"), StudentT::new(3.0, 0.0, 1.0).unwrap());
// Robust likelihood tolerant of outliers.
let obs = observe(addr!("y"), StudentT::new(4.0, 1.0, 0.5).unwrap(), 2.0);

Implementations§

Source§

impl StudentT

Source

pub fn new(df: f64, loc: f64, scale: f64) -> FugueResult<Self>

Create a new Student’s t-distribution with validated parameters.

Source

pub fn df(&self) -> f64

Get the degrees of freedom ν.

Source

pub fn loc(&self) -> f64

Get the location parameter μ.

Source

pub fn scale(&self) -> f64

Get the scale parameter σ.

Trait Implementations§

Source§

impl Clone for StudentT

Source§

fn clone(&self) -> StudentT

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for StudentT

Source§

impl Debug for StudentT

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Distribution<f64> for StudentT

Source§

fn sample(&self, rng: &mut dyn RngCore) -> f64

Generate a random sample (with its natural type), T, from the distribution, using the provided random number generator, rng. Read more
Source§

fn log_prob(&self, x: &f64) -> LogF64

Compute the log-probability density (continuous) or mass (discrete) of a value, x, from the distribution. Read more
Source§

fn clone_box(&self) -> Box<dyn Distribution<f64>>

Clone the distribution into a boxed trait object, Box<dyn Distribution<T>>. Read more
Source§

impl Validate for StudentT

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V