Struct sprs_rand::rand_distr::LogNormal

source · [−]

pub struct LogNormal<N> { /* private fields */ }

Expand description

The log-normal distribution ln N(mean, std_dev**2).

If X is log-normal distributed, then ln(X) is N(mean, std_dev**2) distributed.

Example

use rand_distr::{LogNormal, Distribution};

// mean 2, standard deviation 3
let log_normal = LogNormal::new(2.0, 3.0).unwrap();
let v = log_normal.sample(&mut rand::thread_rng());
println!("{} is from an ln N(2, 9) distribution", v)

Implementations

source

impl<N> LogNormal<N> where
N: Float,
StandardNormal: Distribution<N>,

source

pub fn new(mean: N, std_dev: N) -> Result<LogNormal<N>, Error>

Construct a new LogNormal distribution with the given mean and standard deviation of the logarithm of the distribution.

Trait Implementations

source

impl<N> Clone for LogNormal<N> where
N: Clone,

source

fn clone(&self) -> LogNormal<N>

Returns a copy of the value. Read more

1.0.0 · source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

source

impl<N> Debug for LogNormal<N> where
N: Debug,

source

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

Formats the value using the given formatter. Read more

source

impl<N> Distribution<N> for LogNormal<N> where
N: Float,
StandardNormal: Distribution<N>,

source

fn sample<R>(&self, rng: &mut R) -> N where
R: Rng + ?Sized,

Generate a random value of T, using rng as the source of randomness.

source

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>ⓘNotable traits for DistIter<D, R, T>`impl<D, R, T> Iterator for DistIter<D, R, T> where D: Distribution<T>, R: Rng, type Item = T;` where
R: Rng,

Create an iterator that generates random values of T, using rng as the source of randomness. Read more

source

impl<N> Copy for LogNormal<N> where
N: Copy,

Auto Trait Implementations

impl<N> RefUnwindSafe for LogNormal<N> where
N: RefUnwindSafe,

impl<N> Send for LogNormal<N> where
N: Send,

impl<N> Sync for LogNormal<N> where
N: Sync,

impl<N> Unpin for LogNormal<N> where
N: Unpin,

impl<N> UnwindSafe for LogNormal<N> where
N: UnwindSafe,

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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<N, A, B> MulAcc<A, B> for N where
 N: Copy,
 B: Copy,
 A: MulAdd<B, N, Output = N> + Copy,

source

fn mul_acc(&mut self, a: &A, b: &B)

Multiply and accumulate in this variable, formally *self += a * b.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

unsafe fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct sprs_rand::rand_distr::LogNormal

Example

Implementations

impl<N> LogNormal<N> where N: Float, StandardNormal: Distribution<N>,

pub fn new(mean: N, std_dev: N) -> Result<LogNormal<N>, Error>

Trait Implementations

impl<N> Clone for LogNormal<N> where N: Clone,

fn clone(&self) -> LogNormal<N>

fn clone_from(&mut self, source: &Self)

impl<N> Debug for LogNormal<N> where N: Debug,

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

impl<N> Distribution<N> for LogNormal<N> where N: Float, StandardNormal: Distribution<N>,

fn sample<R>(&self, rng: &mut R) -> N where R: Rng + ?Sized,

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>ⓘNotable traits for DistIter<D, R, T>impl<D, R, T> Iterator for DistIter<D, R, T> where D: Distribution<T>, R: Rng, type Item = T; where R: Rng,

impl<N> Copy for LogNormal<N> where N: Copy,

Auto Trait Implementations

impl<N> RefUnwindSafe for LogNormal<N> where N: RefUnwindSafe,

impl<N> Send for LogNormal<N> where N: Send,

impl<N> Sync for LogNormal<N> where N: Sync,

impl<N> Unpin for LogNormal<N> where N: Unpin,

impl<N> UnwindSafe for LogNormal<N> where N: UnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<N, A, B> MulAcc<A, B> for N where N: Copy, B: Copy, A: MulAdd<B, N, Output = N> + Copy,

fn mul_acc(&mut self, a: &A, b: &B)

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

fn is_in_subset(&self) -> bool

unsafe fn to_subset_unchecked(&self) -> SS

fn from_subset(element: &SS) -> SP

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

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

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<N> LogNormal<N> where
N: Float,
StandardNormal: Distribution<N>,

impl<N> Clone for LogNormal<N> where
N: Clone,

impl<N> Debug for LogNormal<N> where
N: Debug,

impl<N> Distribution<N> for LogNormal<N> where
N: Float,
StandardNormal: Distribution<N>,

fn sample<R>(&self, rng: &mut R) -> N where
R: Rng + ?Sized,

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>ⓘNotable traits for DistIter<D, R, T>`impl<D, R, T> Iterator for DistIter<D, R, T> where D: Distribution<T>, R: Rng, type Item = T;` where
R: Rng,

impl<N> Copy for LogNormal<N> where
N: Copy,

impl<N> RefUnwindSafe for LogNormal<N> where
N: RefUnwindSafe,

impl<N> Send for LogNormal<N> where
N: Send,

impl<N> Sync for LogNormal<N> where
N: Sync,

impl<N> Unpin for LogNormal<N> where
N: Unpin,

impl<N> UnwindSafe for LogNormal<N> where
N: UnwindSafe,

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

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

impl<T> BorrowMut<T> for T where
T: ?Sized,

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

impl<N, A, B> MulAcc<A, B> for N where
N: Copy,
B: Copy,
A: MulAdd<B, N, Output = N> + Copy,

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

impl<T> ToOwned for T where
T: Clone,

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

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,