Trait NumConst

pub trait NumConst: PartialEq<Self::Num> {
    type Num;
Show 18 associated constants and 12 methods
    const NUM_IS_BIG: bool;
    const NUM_IS_INT: bool;
    const NUM_IS_FLOAT: bool;
    const NUM_IS_FIXED: bool;
    const NUM_IS_SIGNED: bool;
    const NUM_IS_NICHE: bool;
    const NUM_ZERO: Option<Self::Num>;
    const NUM_ONE: Option<Self::Num>;
    const NUM_TWO: Option<Self::Num>;
    const NUM_THREE: Option<Self::Num>;
    const NUM_NEG_ONE: Option<Self::Num>;
    const NUM_MIN: Option<Self::Num>;
    const NUM_MAX: Option<Self::Num>;
    const NUM_MIN_POSITIVE: Option<Self::Num>;
    const NUM_MAX_NEGATIVE: Option<Self::Num>;
    const NUM_MIN_NORM: Option<Self::Num>;
    const NUM_MAX_NORM: Option<Self::Num>;
    const NUM_MAX_POWER_OF_TWO: Option<Self::Num>;

    // Provided methods
    fn is_num_zero(&self) -> bool { ... }
    fn is_num_one(&self) -> bool { ... }
    fn is_num_two(&self) -> bool { ... }
    fn is_num_three(&self) -> bool { ... }
    fn is_num_neg_one(&self) -> bool { ... }
    fn is_num_min(&self) -> bool { ... }
    fn is_num_max(&self) -> bool { ... }
    fn is_num_min_positive(&self) -> bool { ... }
    fn is_num_max_negative(&self) -> bool { ... }
    fn is_num_min_norm(&self) -> bool { ... }
    fn is_num_max_norm(&self) -> bool { ... }
    fn is_num_max_power_of_two(&self) -> bool { ... }
}

Expand description

⅀ Fundamental numeric constants for both integer and floating-point types.

Required Associated Constants§

Whether the number can represent big quantities.

Whether the number uses an integer representation.

Whether the number uses a floating-point representation.

Whether the number uses a fixed-point representation.

Whether the number includes the sign.

Whether the number has a memory niche optimization.

The additive identity (0), if applicable.

The multiplicative identity (1).

The only even prime and the fundamental doubling factor (2).

The smallest odd prime and the first nontrivial divisor (3).

The additive inverse of ONE (-1), if applicable.

The smallest representable value.

The greatest representable value.

The smallest representable positive value.

The greatest representable negative value, if applicable.

The smallest normalized value (e.g. 0.0 for float, MIN for integers).

The greatest normalized value (e.g. 1.0 for float, MAX for integers).

The maximum representable power of two within the type’s range.

This is constructed using exact bit manipulation rather than arithmetic operations to ensure consistent results across all platforms.

Required Associated Types§

The underlying numeric type implementing this trait.

Provided Methods§

Whether self is equal to NUM_ZERO.

Whether self is equal to NUM_ONE.

Whether self is equal to NUM_TWO.

Whether self is equal to NUM_THREE.

Whether self is equal to NUM_NEG_ONE.

Whether self is equal to NUM_MIN.

Whether self is equal to NUM_MAX.

Whether self is equal to Some(NUM_MIN_POSITIVE).

Whether self is equal to NUM_MAX_NEGATIVE.

Whether self is equal to NUM_MIN_NORM.

Whether self is equal to NUM_MAX_NORM.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types§

Implementors§

Trait NumConst Copy item path

Required Associated Constants§

const NUM_IS_BIG: bool

const NUM_IS_INT: bool

const NUM_IS_FLOAT: bool

const NUM_IS_FIXED: bool

const NUM_IS_SIGNED: bool

const NUM_IS_NICHE: bool

const NUM_ZERO: Option<Self::Num>

const NUM_ONE: Option<Self::Num>

const NUM_TWO: Option<Self::Num>

const NUM_THREE: Option<Self::Num>

const NUM_NEG_ONE: Option<Self::Num>

const NUM_MIN: Option<Self::Num>

const NUM_MAX: Option<Self::Num>

const NUM_MIN_POSITIVE: Option<Self::Num>

const NUM_MAX_NEGATIVE: Option<Self::Num>

const NUM_MIN_NORM: Option<Self::Num>

const NUM_MAX_NORM: Option<Self::Num>

const NUM_MAX_POWER_OF_TWO: Option<Self::Num>

Required Associated Types§

type Num

Provided Methods§

fn is_num_zero(&self) -> bool

fn is_num_one(&self) -> bool

fn is_num_two(&self) -> bool

fn is_num_three(&self) -> bool

fn is_num_neg_one(&self) -> bool

fn is_num_min(&self) -> bool

fn is_num_max(&self) -> bool

fn is_num_min_positive(&self) -> bool

fn is_num_max_negative(&self) -> bool

fn is_num_min_norm(&self) -> bool

fn is_num_max_norm(&self) -> bool

fn is_num_max_power_of_two(&self) -> bool

Dyn Compatibility§

Implementations on Foreign Types§

impl NumConst for f32

const NUM_IS_BIG: bool = false

const NUM_IS_INT: bool = false

const NUM_IS_FLOAT: bool = true

const NUM_IS_FIXED: bool = false

const NUM_IS_SIGNED: bool = true

const NUM_IS_NICHE: bool = false

const NUM_ZERO: Option<f32>

const NUM_ONE: Option<f32>

const NUM_TWO: Option<f32>

const NUM_THREE: Option<f32>

const NUM_NEG_ONE: Option<f32>

const NUM_MIN: Option<f32>

const NUM_MAX: Option<f32>

const NUM_MIN_POSITIVE: Option<f32>

const NUM_MAX_NEGATIVE: Option<f32>

const NUM_MIN_NORM: Option<f32>

const NUM_MAX_NORM: Option<f32>

const NUM_MAX_POWER_OF_TWO: Option<f32>

type Num = f32

impl NumConst for f64

const NUM_IS_BIG: bool = false

const NUM_IS_INT: bool = false

const NUM_IS_FLOAT: bool = true

const NUM_IS_FIXED: bool = false

const NUM_IS_SIGNED: bool = true

const NUM_IS_NICHE: bool = false

const NUM_ZERO: Option<f64>

const NUM_ONE: Option<f64>

const NUM_TWO: Option<f64>

const NUM_THREE: Option<f64>

const NUM_NEG_ONE: Option<f64>

const NUM_MIN: Option<f64>

const NUM_MAX: Option<f64>

const NUM_MIN_POSITIVE: Option<f64>

const NUM_MAX_NEGATIVE: Option<f64>

const NUM_MIN_NORM: Option<f64>

const NUM_MAX_NORM: Option<f64>

const NUM_MAX_POWER_OF_TWO: Option<f64>

type Num = f64

impl NumConst for i8

const NUM_IS_BIG: bool = false

const NUM_IS_INT: bool = true

Trait NumConst