Struct rv::dist::ScaledInvChiSquared
source · pub struct ScaledInvChiSquared { /* private fields */ }
Expand description
Scaled Χ-2 distribution Scaled-Χ-2(v, τ2).
§Example
use rv::prelude::*;
let ix2 = ScaledInvChiSquared::new(2.0, 1.0).unwrap();
Implementations§
source§impl ScaledInvChiSquared
impl ScaledInvChiSquared
sourcepub fn new(v: f64, t2: f64) -> Result<Self, ScaledInvChiSquaredError>
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, ∞)
sourcepub fn new_unchecked(v: f64, t2: f64) -> Self
pub fn new_unchecked(v: f64, t2: f64) -> Self
Create a new ScaledInvChiSquared without checking whether the parameters are valid.
sourcepub fn v(&self) -> f64
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);
sourcepub fn set_v(&mut self, v: f64) -> Result<(), ScaledInvChiSquaredError>
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(f64::NAN).is_err());
assert!(ix2.set_v(f64::INFINITY).is_err());
pub fn set_v_unchecked(&mut self, v: f64)
sourcepub fn t2(&self) -> 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);
sourcepub fn set_t2(&mut self, t2: f64) -> Result<(), ScaledInvChiSquaredError>
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(f64::NAN).is_err());
assert!(ix2.set_t2(f64::INFINITY).is_err());
pub fn set_t2_unchecked(&mut self, t2: f64)
Trait Implementations§
source§impl Cdf<f32> for ScaledInvChiSquared
impl Cdf<f32> for ScaledInvChiSquared
source§impl Cdf<f64> for ScaledInvChiSquared
impl Cdf<f64> for ScaledInvChiSquared
source§impl Clone for ScaledInvChiSquared
impl Clone for ScaledInvChiSquared
source§fn clone(&self) -> ScaledInvChiSquared
fn clone(&self) -> ScaledInvChiSquared
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl ContinuousDistr<f32> for ScaledInvChiSquared
impl ContinuousDistr<f32> for ScaledInvChiSquared
source§impl ContinuousDistr<f64> for ScaledInvChiSquared
impl ContinuousDistr<f64> for ScaledInvChiSquared
source§impl Debug for ScaledInvChiSquared
impl Debug for ScaledInvChiSquared
source§impl<'de> Deserialize<'de> for ScaledInvChiSquared
impl<'de> Deserialize<'de> for ScaledInvChiSquared
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
source§impl Display for ScaledInvChiSquared
impl Display for ScaledInvChiSquared
source§impl From<&ScaledInvChiSquared> for String
impl From<&ScaledInvChiSquared> for String
source§fn from(ix2: &ScaledInvChiSquared) -> String
fn from(ix2: &ScaledInvChiSquared) -> String
Converts to this type from the input type.
source§impl HasDensity<f32> for ScaledInvChiSquared
impl HasDensity<f32> for ScaledInvChiSquared
source§impl HasDensity<f64> for ScaledInvChiSquared
impl HasDensity<f64> for ScaledInvChiSquared
source§impl Mean<f32> for ScaledInvChiSquared
impl Mean<f32> for ScaledInvChiSquared
source§impl Mean<f64> for ScaledInvChiSquared
impl Mean<f64> for ScaledInvChiSquared
source§impl Mode<f32> for ScaledInvChiSquared
impl Mode<f32> for ScaledInvChiSquared
source§impl Mode<f64> for ScaledInvChiSquared
impl Mode<f64> for ScaledInvChiSquared
source§impl Parameterized for ScaledInvChiSquared
impl Parameterized for ScaledInvChiSquared
type Parameters = ScaledInvChiSquaredParameters
fn emit_params(&self) -> Self::Parameters
fn from_params(params: Self::Parameters) -> Self
source§impl PartialEq for ScaledInvChiSquared
impl PartialEq for ScaledInvChiSquared
source§fn eq(&self, other: &ScaledInvChiSquared) -> bool
fn eq(&self, other: &ScaledInvChiSquared) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.source§impl Sampleable<f32> for ScaledInvChiSquared
impl Sampleable<f32> for ScaledInvChiSquared
source§impl Sampleable<f64> for ScaledInvChiSquared
impl Sampleable<f64> for ScaledInvChiSquared
source§impl Serialize for ScaledInvChiSquared
impl Serialize for ScaledInvChiSquared
source§impl Support<f32> for ScaledInvChiSquared
impl Support<f32> for ScaledInvChiSquared
source§impl Support<f64> for ScaledInvChiSquared
impl Support<f64> for ScaledInvChiSquared
source§impl Variance<f32> for ScaledInvChiSquared
impl Variance<f32> for ScaledInvChiSquared
Auto Trait Implementations§
impl !Freeze for ScaledInvChiSquared
impl RefUnwindSafe for ScaledInvChiSquared
impl Send for ScaledInvChiSquared
impl Sync for ScaledInvChiSquared
impl Unpin for ScaledInvChiSquared
impl UnwindSafe for ScaledInvChiSquared
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self
from the equivalent element of its
superset. Read moresource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self
is actually part of its subset T
(and can be converted to it).source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset
but without any property checks. Always succeeds.source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self
to the equivalent element of its superset.