fast-posit 0.2.0

Software implementation of the Posit floating point format
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

use super::*;

// The `Int` trait has bounds indirectly, via `Sealed`. For example, we don't have `Int:
// PartialEq`, we have `Int: Sealed` and `Sealed: PartialEq`, so the derive macro derives
//
//   impl<const N: u32, const ES: u32, Int: PartialEq + Int> PartialEq for Posit<N, ES, Int>
//
// but of course we know we can just have
//
//   impl<const N: u32, const ES: u32, Int: Int> PartialEq for Posit<N, ES, Int>
//
// Because of that we just implement explicitly here.

impl<const N: u32, const ES: u32, const RS: u32, Int: crate::Int>
Clone for Posit<N, ES, Int, RS> {
  #[inline]
  fn clone(&self) -> Self {
    *self
  }
}

impl<const N: u32, const ES: u32, const RS: u32, Int: crate::Int>
Copy for Posit<N, ES, Int, RS> {}

/// Note that, **unlike IEEE floats**, [NaR](Self::NAR) is equal to itself (and different from any
/// other value).
///
/// # Example
///
/// ```
/// # use fast_posit::*;
/// assert!(p32::NAR == p32::NAR);
/// assert!(f32::NAN != f32::NAN);
///
/// assert!(p32::NAR != 3.round_into());
/// assert!(f32::NAN != 3.);
/// ```
impl<const N: u32, const ES: u32, const RS: u32, Int: crate::Int>
PartialEq for Posit<N, ES, Int, RS> {
  #[inline]
  fn eq(&self, other: &Self) -> bool {
    self.0 == other.0
  }
}

impl<const N: u32, const ES: u32, const RS: u32, Int: crate::Int>
Eq for Posit<N, ES, Int, RS> {}

/// Note that, **unlike IEEE floats**, posits have a total order (i.e. implement [`Ord`]).
/// [NaR](Self::NAR) is always smaller than any other value, and equal to itself.
///
/// # Example
///
/// ```
/// # use fast_posit::*;
/// # use core::cmp::Ordering;
/// assert_eq!(p32::NAR.partial_cmp(&p32::NAR), Some(Ordering::Equal));
/// assert_eq!(f32::NAN.partial_cmp(&f32::NAN), None);
///
/// assert!(p32::NAR < p32::round_from(-3));
/// assert!(!(f32::NAN < -3.) && !(f32::NAN >= -3.));
/// ```
impl<const N: u32, const ES: u32, const RS: u32, Int: crate::Int>
PartialOrd for Posit<N, ES, Int, RS> {
  #[inline]
  fn partial_cmp(&self, other: &Self) -> Option<core::cmp::Ordering> {
    Some(self.cmp(other))
  }
}

impl<const N: u32, const ES: u32, const RS: u32, Int: crate::Int>
Ord for Posit<N, ES, Int, RS> {
  #[inline]
  fn cmp(&self, other: &Self) -> core::cmp::Ordering {
    self.0.cmp(&other.0)
  }
}

impl<const N: u32, const ES: u32, const RS: u32, Int: crate::Int>
core::hash::Hash for Posit<N, ES, Int, RS> {
  #[inline]
  fn hash<H: core::hash::Hasher>(&self, state: &mut H) {
    self.0.hash(state);
  }
}

impl<const N: u32, const ES: u32, const RS: u32, Int: crate::Int>
Default for Posit<N, ES, Int, RS> {
  #[inline]
  fn default() -> Self {
    Self(Default::default())
  }
}