Struct rv::dist::Pareto [−][src]
pub struct Pareto { /* fields omitted */ }
Pareto distribution Pareto(x_m, α) over x in (x_m, ∞).
NOTE: The Pareto distribution is parameterized in terms of shape, α, and scale, x_m.
α x_m^α
f(x|α, x_m) = ---------
x^(α + 1)
Implementations
impl Pareto
[src]
impl Pareto
[src]pub fn new(shape: f64, scale: f64) -> Result<Self, ParetoError>
[src]
Create a new Pareto
distribution with shape (α) and scale (x_m).
pub fn new_unchecked(shape: f64, scale: f64) -> Self
[src]
Creates a new Pareto without checking whether the parameters are valid.
pub fn shape(&self) -> f64
[src]
Get shape parameter
Example
let pareto = Pareto::new(1.0, 2.0).unwrap(); assert_eq!(pareto.shape(), 1.0);
pub fn set_shape(&mut self, shape: f64) -> Result<(), ParetoError>
[src]
Set the shape parameter
Example
use rv::dist::Pareto; let mut pareto = Pareto::new(2.0, 1.0).unwrap(); assert_eq!(pareto.shape(), 2.0); pareto.set_shape(1.1).unwrap(); assert_eq!(pareto.shape(), 1.1);
Will error for invalid values
assert!(pareto.set_shape(1.1).is_ok()); assert!(pareto.set_shape(0.0).is_err()); assert!(pareto.set_shape(-1.0).is_err()); assert!(pareto.set_shape(std::f64::INFINITY).is_err()); assert!(pareto.set_shape(std::f64::NEG_INFINITY).is_err()); assert!(pareto.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 scale parameter
Example
let pareto = Pareto::new(1.0, 2.0).unwrap(); assert_eq!(pareto.scale(), 2.0);
pub fn set_scale(&mut self, scale: f64) -> Result<(), ParetoError>
[src]
Set the scale parameter
Example
use rv::dist::Pareto; let mut pareto = Pareto::new(2.0, 1.0).unwrap(); assert_eq!(pareto.scale(), 1.0); pareto.set_scale(1.1).unwrap(); assert_eq!(pareto.scale(), 1.1);
Will error for invalid values
assert!(pareto.set_scale(1.1).is_ok()); assert!(pareto.set_scale(0.0).is_err()); assert!(pareto.set_scale(-1.0).is_err()); assert!(pareto.set_scale(std::f64::INFINITY).is_err()); assert!(pareto.set_scale(std::f64::NEG_INFINITY).is_err()); assert!(pareto.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 Pareto
[src]
impl ContinuousDistr<f32> for Pareto
[src]impl ContinuousDistr<f64> for Pareto
[src]
impl ContinuousDistr<f64> for Pareto
[src]impl StructuralPartialEq for Pareto
[src]
impl StructuralPartialEq for Pareto
[src]Auto Trait Implementations
impl RefUnwindSafe for Pareto
impl RefUnwindSafe for Pareto
impl UnwindSafe for Pareto
impl UnwindSafe for Pareto
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>,