Struct rand_simple::Frechet

source ·
pub struct Frechet { /* private fields */ }
Expand description

Frechet Distribution

Example

let mut frechet = rand_simple::Frechet::new(1192u32);
assert_eq!(format!("{frechet}"), "Fr(Shape parameter, Scale parameter) = Fr(1, 1)");

// Modifying the parameters of the random variable
let shape: f64 = 2_f64;
let scale: f64 = 1.5_f64;
let result: Result<(f64, f64), &str> = frechet.try_set_params(shape, scale);
assert_eq!(format!("{frechet}"), "Fr(Shape parameter, Scale parameter) = Fr(2, 1.5)");

Implementations§

source§

impl Frechet

source

pub fn new(_seed: u32) -> Self

Constructor for creating a new instance of the Frechet distribution.

Arguments
  • _seed - The seed for initializing the random number generator.
Returns

A new instance of the Frechet distribution with default parameters (shape = 1, scale = 1).

source

pub fn sample(&mut self) -> f64

Generate a random number.

source

pub fn try_set_params( &mut self, shape: f64, scale: f64 ) -> Result<(f64, f64), &str>

Try to set the parameters of the random variable.

  • shape - Shape parameter.
  • scale - Scale parameter.

Trait Implementations§

source§

impl Display for Frechet

source§

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

Formatter for displaying the Frechet distribution parameters.

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> 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> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

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

§

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>,

§

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.