Struct FiniteF64

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

A finite 64-bit floating point type.

This is a restricted version of f64 that does not allow NaN or infinity.

Implementations

impl FiniteF64

pub const MAX: Self = _

Largest finite value.

pub const MIN: Self = _

Smallest finite value.

pub const EPSILON: Self = _

Smallest positive normal value.

pub const unsafe fn new_unchecked(value: f64) -> Self

Creates a finite float without checking whether the value is finte. This results in undefined behavior if the value is non-finite.

Safety

The value must not be NaN or infinite.

pub fn new(value: f64) -> Option<Self>

Creates a finite float if the value is finite.

pub const fn to_f64(self) -> f64

Returns the plain f64.

pub fn abs(self) -> Self

Computes the absolute value of self.

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

Returns the maximum of two numbers.

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

Returns the minimum of two numbers.

pub fn saturating_add(self, other: Self) -> Self

Adds two numbers, saturating at the maximum and minimum representable values.

pub fn saturating_sub(self, other: Self) -> Self

Adds two numbers, saturating at the maximum and minimum representable values.

pub fn saturating_mul(self, other: Self) -> Self

Multiplies two numbers, saturating at the maximum and minimum representable values.

pub fn saturating_div(self, other: Self) -> Self

Divides two numbers, saturating at the maximum and minimum representable values.

Trait Implementations

impl Add for FiniteF64

type Output = Option<FiniteF64>

The resulting type after applying the + operator.

fn add(self, other: Self) -> Option<Self>

Performs the + operation.

impl Clone for FiniteF64

fn clone(&self) -> FiniteF64

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FiniteF64

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

Formats the value using the given formatter.

impl Default for FiniteF64

fn default() -> FiniteF64

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FiniteF64

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FiniteF64

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

Formats the value using the given formatter.

impl Div for FiniteF64

type Output = Option<FiniteF64>

The resulting type after applying the / operator.

fn div(self, other: Self) -> Option<Self>

Performs the / operation.

impl From<FiniteF64> for f64

fn from(value: FiniteF64) -> Self

Converts to this type from the input type.

impl From<i16> for FiniteF64

fn from(value: i16) -> Self

Converts to this type from the input type.

impl From<i32> for FiniteF64

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i8> for FiniteF64

fn from(value: i8) -> Self

Converts to this type from the input type.

impl From<u16> for FiniteF64

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u32> for FiniteF64

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u8> for FiniteF64

fn from(value: u8) -> Self

Converts to this type from the input type.

impl FromStr for FiniteF64

type Err = ParseFiniteFloatError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for FiniteF64

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 Mul for FiniteF64

type Output = Option<FiniteF64>

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Option<Self>

Performs the * operation.

impl Ord for FiniteF64

fn cmp(&self, other: &Self) -> 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 FiniteF64

fn eq(&self, other: &FiniteF64) -> 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 PartialOrd for FiniteF64

fn partial_cmp(&self, other: &Self) -> 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 Rem for FiniteF64

type Output = Option<FiniteF64>

The resulting type after applying the % operator.

fn rem(self, other: Self) -> Option<Self>

Performs the % operation.

impl Serialize for FiniteF64

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for FiniteF64

type Output = Option<FiniteF64>

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Option<Self>

Performs the - operation.

impl TryFrom<f32> for FiniteF64

type Error = TryFromFloatError

The type returned in the event of a conversion error.

fn try_from(value: f32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<f64> for FiniteF64

type Error = TryFromFloatError

The type returned in the event of a conversion error.

fn try_from(value: f64) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for FiniteF64

impl Eq for FiniteF64

impl StructuralPartialEq for FiniteF64