Struct GaussianMaxStdDev 

pub struct GaussianMaxStdDev(/* private fields */);

The Gaussian’s maximum standard deviation.

Implementations

impl GaussianMaxStdDev

pub const fn new(max_std_dev: f32) -> Option<Self>

Create a new Gaussian maximum standard deviation.

Returns None if the maximum standard deviation is not in the range of [0.0, 3.0].

pub const unsafe fn new_unchecked(max_std_dev: f32) -> Self

Create a new Gaussian maximum standard deviation without checking.

Safety

The maximum standard deviation must be in the range of [0.0, 3.0].

pub const fn get(&self) -> f32

Get the maximum standard deviation.

Note that the returned value may have a small precision loss due to the internal representation of u8.

pub const fn as_u8(&self) -> u8

Get the maximum standard deviation as the internal representation of u8.

Trait Implementations

impl Clone for GaussianMaxStdDev

fn clone(&self) -> GaussianMaxStdDev

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GaussianMaxStdDev

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

Formats the value using the given formatter.

impl Default for GaussianMaxStdDev

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for GaussianMaxStdDev

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

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

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 Copy for GaussianMaxStdDev

impl Eq for GaussianMaxStdDev

impl StructuralPartialEq for GaussianMaxStdDev