Struct rv::dist::Gev [−][src]
pub struct Gev { /* fields omitted */ }
Generalized Extreme Value Distribution Gev(μ, σ, ξ) where the parameters are μ is location σ is the scale ξ is the shape
f(x|μ, σ, ξ) = \frac{1}{σ} t(x)^{ξ + 1} e^{-t(x)}
t(x) = ⎰ (1 + ξ ((x - μ) / σ))^(-1/ξ) if ξ ≠ 0
⎱ e^{(μ - x) / σ} if ξ = 0
Implementations
impl Gev
[src]
impl Gev
[src]pub fn new(loc: f64, scale: f64, shape: f64) -> Result<Self, GevError>
[src]
Create a new Gev
distribution with location, scale, and shape.
pub fn new_unchecked(loc: f64, scale: f64, shape: f64) -> Self
[src]
Creates a new Gev without checking whether the parameters are valid.
pub fn loc(&self) -> f64
[src]
Get the location parameter
Example
let gev = Gev::new(1.2, 2.3, 3.4).unwrap(); assert_eq!(gev.loc(), 1.2);
pub fn set_loc(&mut self, loc: f64) -> Result<(), GevError>
[src]
Set the loc parameter without input validation
Example
let mut gev = Gev::new(1.2, 2.3, 3.4).unwrap(); assert_eq!(gev.loc(), 1.2); gev.set_loc(2.8).unwrap(); assert_eq!(gev.loc(), 2.8);
Will error for invalid values
assert!(gev.set_loc(2.8).is_ok()); assert!(gev.set_loc(std::f64::INFINITY).is_err()); assert!(gev.set_loc(std::f64::NEG_INFINITY).is_err()); assert!(gev.set_loc(std::f64::NAN).is_err());
pub fn set_loc_unchecked(&mut self, loc: f64)
[src]
Set the loc parameter without input validation
pub fn shape(&self) -> f64
[src]
Get the shape parameter
Example
let gev = Gev::new(1.2, 2.3, 3.4).unwrap(); assert_eq!(gev.shape(), 3.4);
pub fn set_shape(&mut self, shape: f64) -> Result<(), GevError>
[src]
Set the shape parameter without input validation
Example
let mut gev = Gev::new(1.2, 2.3, 3.4).unwrap(); assert_eq!(gev.shape(), 3.4); gev.set_shape(2.8).unwrap(); assert_eq!(gev.shape(), 2.8);
Will error for invalid values
assert!(gev.set_shape(2.8).is_ok()); assert!(gev.set_shape(std::f64::INFINITY).is_err()); assert!(gev.set_shape(std::f64::NEG_INFINITY).is_err()); assert!(gev.set_shape(std::f64::NAN).is_err());
pub fn set_shape_unchecked(&mut self, shape: f64)
[src]
Set the shape parameter without input validation
pub fn scale(&self) -> f64
[src]
Get the scale parameter
Example
let gev = Gev::new(1.2, 2.3, 3.4).unwrap(); assert_eq!(gev.scale(), 2.3);
pub fn set_scale(&mut self, scale: f64) -> Result<(), GevError>
[src]
Set the scale parameter without input validation
Example
let mut gev = Gev::new(1.2, 2.3, 3.4).unwrap(); assert_eq!(gev.scale(), 2.3); gev.set_scale(2.8).unwrap(); assert_eq!(gev.scale(), 2.8);
Will error for invalid values
assert!(gev.set_scale(2.8).is_ok()); assert!(gev.set_scale(0.0).is_err()); assert!(gev.set_scale(-1.0).is_err()); assert!(gev.set_scale(std::f64::INFINITY).is_err()); assert!(gev.set_scale(std::f64::NEG_INFINITY).is_err()); assert!(gev.set_scale(std::f64::NAN).is_err());
pub fn set_scale_unchecked(&mut self, scale: f64)
[src]
Set the scale parameter without input validation
Trait Implementations
impl ContinuousDistr<f32> for Gev
[src]
impl ContinuousDistr<f32> for Gev
[src]impl ContinuousDistr<f64> for Gev
[src]
impl ContinuousDistr<f64> for Gev
[src]impl StructuralPartialEq for Gev
[src]
impl StructuralPartialEq for Gev
[src]Auto Trait Implementations
impl RefUnwindSafe for Gev
impl RefUnwindSafe for Gev
impl UnwindSafe for Gev
impl UnwindSafe for Gev
Blanket Implementations
impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
pub fn to_subset(&self) -> Option<SS>
pub fn is_in_subset(&self) -> bool
pub fn to_subset_unchecked(&self) -> SS
pub fn from_subset(element: &SS) -> SP
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,