Struct LecunNormal

pub struct LecunNormal { /* private fields */ }

LecunNormal is a truncated normal distribution centered at 0 with a standard deviation that is calculated as:

$$ \sigma = {n_{in}}^{-\frac{1}{2}} $$

where $n_{in}$ is the number of input units.

Implementations

impl LecunNormal

pub const fn new(n: usize) -> Self

pub fn distr<F>(&self) -> Result<TruncatedNormal<F>, InitError>

where F: Float, StandardNormal: Distribution<F>,

Create a truncated normal distribution centered at 0; See Self::std_dev for the standard deviation calculations.

pub fn std_dev<F>(&self) -> F

where F: Float,

Calculate the standard deviation ($\sigma$) of the distribution. This is done by computing the root of the reciprocal of the number of inputs ($n_{in}$) as follows:

\sigma = {n_{in}}^{-\frac{1}{2}}

Trait Implementations

impl Clone for LecunNormal

fn clone(&self) -> LecunNormal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LecunNormal

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

Formats the value using the given formatter.

impl<F> Distribution<F> for LecunNormal

where F: Float, StandardNormal: Distribution<F>,

fn sample<R>(&self, rng: &mut R) -> F

where R: RngCore + ?Sized,

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

fn sample_iter<R>(self, rng: R) -> Iter<Self, R, T>

where R: Rng, Self: Sized,

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

fn map<F, S>(self, func: F) -> Map<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Map sampled values to type S

impl Hash for LecunNormal

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for LecunNormal

fn cmp(&self, other: &LecunNormal) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for LecunNormal

fn eq(&self, other: &LecunNormal) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for LecunNormal

fn partial_cmp(&self, other: &LecunNormal) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for LecunNormal

impl Eq for LecunNormal

impl StructuralPartialEq for LecunNormal