fixed2float 4.0.1

Fixed point to floating point conversion utility
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
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

use super::FixedPoint;
use crate::{fixed_point::debug_print, mask, to_float, UInt};

//#[deprecated(since="4.0.0", note="Use `Fx` instead")]
#[derive(PartialEq, Eq, Clone, Copy)]
pub struct Q {
  pub val: UInt,
  pub m: i32,
  pub n: i32,
  pub is_exact: bool,
}

impl Q {
  pub fn new(val: UInt, m: i32, n: i32, is_exact: bool) -> Self {
    Self {
      val,
      m,
      n,
      is_exact,
    }
  }
}

impl FixedPoint for Q {
  fn eval(&self) -> f64 {
    to_float(self.val, self.m + self.n, self.m, self.n).unwrap()
  }

  // fn index(&self, _range: std::ops::Range<usize>) -> Result<Self, String> {
  //         use super::mask;

  //         let (left_idx, right_idx) = (range.start + 1, range.end);
  //         if left_idx < right_idx {
  //             return Err("Left index can't be larger than right index".to_string());
  //         }
  //         let range_size = (left_idx - right_idx) as i32;

  //         if left_idx as i32 > self.m + self.n {
  //             return Err("Left index can't be larger than fixed point number itself".to_string());
  //         }
  //         if range_size == 0 {
  //             return Err("Range can't be null".to_string());
  //         }

  //         let new_val = (self.val >> right_idx) & mask(left_idx as u128);
  //         let new_n = std::cmp::max(0, self.n - right_idx as i32 );
  //         let new_m = range_size - new_n;
  //         Ok(Self {
  //             val: new_val,
  //             m: new_m,
  //             n: new_n,
  //             is_exact: true,
  //         })
  //     unimplemented!()
  // }
}

impl std::ops::Shl<u32> for Q {
  type Output = Self;
  fn shl(self, rhs: u32) -> Self::Output {
    Self {
      val: (self.val << rhs) & mask((self.m + self.n) as u32) as UInt,
      m: self.m,
      n: self.n,
      is_exact: self.is_exact,
    }
  }
}

impl std::ops::Shr<u32> for Q {
  type Output = Self;
  fn shr(self, rhs: u32) -> Self::Output {
    Self {
      val: (self.val >> rhs) & mask((self.m + self.n) as u32) as UInt,
      m: self.m,
      n: self.n,
      is_exact: self.is_exact,
    }
  }
}

impl std::ops::Add for Q {
  type Output = Self;
  fn add(self, rhs: Self) -> Self::Output {
    if self.m != rhs.m || self.n != rhs.n {
      panic!("`m` and `n` field of each Fx obj must match.")
    }
    Self {
      val: self.val + rhs.val,
      m: self.m + 1,
      n: self.n,
      is_exact: true,
    }
  }
}

impl std::ops::Sub for Q {
  type Output = Self;
  fn sub(self, rhs: Self) -> Self::Output {
    if rhs.eval() > self.eval() {
      unimplemented!()
    }
    Self {
      val: self.val - rhs.val,
      m: self.m,
      n: self.n,
      is_exact: true,
    }
  }
}

impl std::ops::Mul for Q {
  type Output = Self;
  fn mul(self, rhs: Self) -> Self::Output {
    Self {
      val: self.val * rhs.val,
      m: self.m + rhs.m,
      n: self.n + rhs.n,
      is_exact: true,
    }
  }
}

impl std::fmt::Debug for Q {
  fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
    let ans = debug_print(self.val, self.m, self.m + self.n, self.is_exact);
    write!(f, "{}", ans)
  }
}

impl std::fmt::Display for Q {
  fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
    let ans = format!("Q<{},{}>({})", self.m, self.n, self.val);
    // ans = self.q_fmt();
    write!(f, "{}", ans)
  }
}

#[allow(non_snake_case)]
pub fn to_Q(x: f64, m: i32, n: i32, round: bool) -> Result<Q, String> {
  crate::to_fixed(x, m, n, round)
}