Struct rand_simple::Laplace

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

Laplace Distribution

Example

let mut laplace = rand_simple::Laplace::new(1192u32);
assert_eq!(format!("{laplace}"), "La(Location parameter, Scale parameter) = La(0, 1)");
println!("Returns a random number -> {}", laplace.sample());

// Modify the distribution's parameters
let location: f64 = -2f64;
let scale: f64 = 1.5f64;
let result: Result<(f64, f64), &str> = laplace.try_set_params(location, scale);
assert_eq!(format!("{laplace}"), "La(Location parameter, Scale parameter) = La(-2, 1.5)");
println!("Returns a random number -> {}", laplace.sample());

Implementations§

source§

impl Laplace

source

pub fn new(_seed: u32) -> Self

Constructor

  • _seed - Random seed to initialize the generator.
source

pub fn sample(&mut self) -> f64

Calculate a random number.

source

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

Modify the parameters of the random variable.

  • location - Location parameter
  • scale - Scale parameter

Trait Implementations§

source§

impl Display for Laplace

Formatter for displaying with macros like println!

  • Location parameter
  • Scale parameter
source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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 Twhere 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 Twhere 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 Twhere 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.