noisy_float 0.2.1

Contains floating point types that panic if they are set to an illegal value, such as NaN
Documentation 
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

// Copyright 2016-2021 Matthew D. Michelotti
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Standard definitions of `NoisyFloat`.
//!
//! Definitions in this module all use `debug_assert!`
//! to check for valid values, so there is no overhead
//! when running in an optimized build.

use crate::{
    checkers::{FiniteChecker, NumChecker},
    NoisyFloat,
};
use core::marker::PhantomData;

/// A floating point number behaving like `f32` that does not allow NaN.
///
/// The "N" in the name stands for "Number", since all values of this type
/// are "numbers", i.e. they are not "not-a-number".
pub type N32 = NoisyFloat<f32, NumChecker>;

/// A floating point number behaving like `f64` that does not allow NaN.
///
/// The "N" in the name stands for "Number", since all values of this type
/// are "numbers", i.e. they are not "not-a-number".
pub type N64 = NoisyFloat<f64, NumChecker>;

/// A floating point number behaving like `f32` that does not allow NaN or +/- Infinity.
///
/// The "R" in the name stands for "Real", since in Mathematics, the Real
/// numbers do not include NaN or +/- Infinity.
pub type R32 = NoisyFloat<f32, FiniteChecker>;

/// A floating point number behaving like `f64` that does not allow NaN or +/- Infinity.
///
/// The "R" in the name stands for "Real", since in Mathematics, the Real
/// numbers do not include NaN or +/- Infinity.
pub type R64 = NoisyFloat<f64, FiniteChecker>;

/// Shorthand for `N32::new(value)`.
#[inline]
pub const fn n32(value: f32) -> N32 {
    debug_assert!(!value.is_nan());
    N32::unchecked_new(value)
}

/// Shorthand for `N64::new(value)`.
#[inline]
pub const fn n64(value: f64) -> N64 {
    debug_assert!(!value.is_nan());
    N64::unchecked_new(value)
}

/// Shorthand for `R32::new(value)`.
#[inline]
pub const fn r32(value: f32) -> R32 {
    debug_assert!(value.is_finite());
    R32::unchecked_new(value)
}

/// Shorthand for `R64::new(value)`.
#[inline]
pub const fn r64(value: f64) -> R64 {
    debug_assert!(value.is_finite());
    R64::unchecked_new(value)
}

macro_rules! const_fns {
    ($type:ty, $raw:ty) => {
        impl $type {
            /// A const constructor that does not check whether `value` is valid.
            ///
            /// WARNING: This constructor does not panic even in debug mode.
            /// As always, it is the user's responsibility to ensure `value` is valid.
            /// Until Rust supports panics in const functions, this constructor
            /// is necessary to create a NoisyFloat in a const setting.
            pub const fn unchecked_new(value: $raw) -> Self {
                Self {
                    value,
                    checker: PhantomData,
                }
            }

            /// A const function that returns the underlying float value.
            pub const fn const_raw(self) -> $raw {
                self.value
            }
        }
    };
}

const_fns!(N32, f32);
const_fns!(N64, f64);
const_fns!(R32, f32);
const_fns!(R64, f64);