1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

use crate::{ErrorKind, Result};
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};
use std::cmp::Ordering;
use std::fmt;
use std::ops;

macro_rules! impl_basic_ops {
    ($ty:ident) => {
        impl ops::Add for $ty {
            type Output = $ty;

            fn add(self, other: Self) -> Self::Output {
                $ty::new(self.0 + other.0).unwrap_or_else(|e| {
                    panic!("self={:?}, other={:?}, error={}", self.0, other.0, e)
                })
            }
        }
        impl ops::AddAssign for $ty {
            fn add_assign(&mut self, other: Self) {
                *self = *self + other;
            }
        }
        impl ops::Sub for $ty {
            type Output = $ty;

            fn sub(self, other: Self) -> Self::Output {
                $ty::new(self.0 - other.0).unwrap_or_else(|e| {
                    panic!("self={:?}, other={:?}, error={}", self.0, other.0, e)
                })
            }
        }
        impl ops::SubAssign for $ty {
            fn sub_assign(&mut self, other: Self) {
                *self = *self - other;
            }
        }
        impl ops::Mul for $ty {
            type Output = $ty;

            fn mul(self, other: Self) -> Self::Output {
                $ty::new(self.0 * other.0).unwrap_or_else(|e| {
                    panic!("self={:?}, other={:?}, error={}", self.0, other.0, e)
                })
            }
        }
        impl ops::MulAssign for $ty {
            fn mul_assign(&mut self, other: Self) {
                *self = *self * other;
            }
        }
        impl ops::Div for $ty {
            type Output = $ty;

            fn div(self, other: Self) -> Self::Output {
                $ty::new(self.0 / other.0).unwrap_or_else(|e| {
                    panic!("self={:?}, other={:?}, error={}", self.0, other.0, e)
                })
            }
        }
        impl ops::DivAssign for $ty {
            fn div_assign(&mut self, other: Self) {
                *self = *self / other;
            }
        }
    };
}

/// An floating point number that is neither infinite nor NaN.
#[derive(Debug, Default, Clone, Copy, PartialEq, PartialOrd)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))] // TODO: validate deserialization
pub struct FiniteF64(f64);
impl FiniteF64 {
    /// Creates a `FiniteF64` instance without checking the value.
    ///
    /// # Safety
    ///
    /// The value must not be NaN or infinite.
    pub const unsafe fn new_unchecked(n: f64) -> Self {
        Self(n)
    }

    /// Creates a finite number.
    ///
    /// # Error
    ///
    /// If the given value is NaN or infinite, an `ErrorKind::InvalidInput` error will be returned.
    pub fn new(n: f64) -> Result<Self> {
        track_assert!(n.is_finite(), ErrorKind::InvalidInput; n);
        Ok(Self(n))
    }

    /// Returns the value as a primitive type.
    pub const fn get(self) -> f64 {
        self.0
    }
}
impl Eq for FiniteF64 {}
impl Ord for FiniteF64 {
    fn cmp(&self, other: &Self) -> Ordering {
        self.0
            .partial_cmp(&other.0)
            .unwrap_or_else(|| unreachable!())
    }
}
impl fmt::Display for FiniteF64 {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        self.0.fmt(f)
    }
}
impl_basic_ops!(FiniteF64);

/// An floating point number that is known not NaN.
#[derive(Debug, Default, Clone, Copy, PartialEq, PartialOrd)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))] // TODO: validate deserialization
pub struct NonNanF64(f64);
impl NonNanF64 {
    /// Creates a non NaN without checking the value.
    ///
    /// # Safety
    ///
    /// The value must not be NaN.
    pub const unsafe fn new_unchecked(n: f64) -> Self {
        Self(n)
    }

    /// Creates a non NaN if the given value is not NaN.
    ///
    /// # Error
    ///
    /// If the given value is NaN, an `ErrorKind::InvalidInput` error will be returned.
    pub fn new(n: f64) -> Result<Self> {
        track_assert!(!n.is_nan(), ErrorKind::InvalidInput);
        Ok(Self(n))
    }

    /// Returns the value as a primitive type.
    pub const fn get(self) -> f64 {
        self.0
    }
}
impl Eq for NonNanF64 {}
impl Ord for NonNanF64 {
    fn cmp(&self, other: &Self) -> Ordering {
        self.0
            .partial_cmp(&other.0)
            .unwrap_or_else(|| unreachable!())
    }
}
impl fmt::Display for NonNanF64 {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        self.0.fmt(f)
    }
}
impl_basic_ops!(NonNanF64);