-
Notifications
You must be signed in to change notification settings - Fork 12
/
UInt.purs
306 lines (262 loc) · 7.06 KB
/
UInt.purs
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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
module Data.UInt
( UInt
, fromInt
, fromInt'
, toInt
, toInt'
, fromNumber
, fromNumber'
, toNumber
, floor
, ceil
, round
, even
, odd
, pow
, and
, (.&.)
, or
, (.|.)
, xor
, (.^.)
, shl
, shr
, zshr
, complement
, toString
, fromString
) where
import Data.Maybe (Maybe(..))
import Data.Semiring (class Semiring)
import Data.Ring (class Ring, negate)
import Data.CommutativeRing (class CommutativeRing)
import Data.EuclideanRing (class EuclideanRing, mod)
import Data.Eq (class Eq, (==))
import Data.Ord (class Ord, Ordering(..), clamp)
import Data.Bounded (class Bounded, top, bottom)
import Data.Show (class Show)
import Data.Function ((<<<))
import Data.Semigroup ((<>))
import Data.Enum (class Enum)
import Prelude ((<), (>), (+), (-))
import Data.Number (ceil, floor, round) as Number
-- | 32-bit unsigned integer. Range from *0* to *4294967295*.
newtype UInt = UInt Number
foreign import exact :: forall a b. (b -> Maybe b) -> Maybe b -> (a -> b) -> a -> Maybe b
foreign import from :: forall a. a -> UInt
instance enumUInt :: Enum UInt where
succ n = if n < top then Just (n + fromInt 1) else Nothing
pred n = if n > bottom then Just (n - fromInt 1) else Nothing
-- | Cast an `Int` to an `UInt` turning negative `Int`s into `UInt`s
-- | in range from `2^31` to `2^32-1`.
-- |
-- | > fromInt 123
-- | 123u
-- |
-- | > fromInt (-123)
-- | 4294967173u
fromInt :: Int -> UInt
fromInt = from
-- | Converts positive `Int`s into `UInt`. Returns `Nothing` for
-- | negative `Int`s
-- |
-- | > fromInt' 123
-- | (Just 123u)
-- |
-- | > fromInt' (-123)
-- | Nothing
fromInt' :: Int -> Maybe UInt
fromInt' = exact Just Nothing fromInt
-- | Cast an `UInt` to an `Int` turning `UInt`s in range from `2^31`
-- | to `2^32-1` into negative `Int`s.
-- |
-- | > toInt (fromInt 123)
-- | 123
-- |
-- | > toInt (fromInt (-1))
-- | -1
foreign import toInt :: UInt -> Int
-- | Converts `UInt`s in range from `0` to `2^31-1` into `Int`s. Returns
-- | `Nothing` for `UInt`'s in range from `2^31` to `2^32-1`.
-- |
-- | > toInt' (fromInt 123)
-- | (Just 123)
-- |
-- | > toInt' (fromInt (-1))
-- | Nothing
toInt' :: UInt -> Maybe Int
toInt' = exact Just Nothing toInt
foreign import uintAdd :: UInt -> UInt -> UInt
foreign import uintMul :: UInt -> UInt -> UInt
instance uintSemiring :: Semiring UInt where
zero = fromInt 0
add = uintAdd
one = fromInt 1
mul = uintMul
foreign import uintSub :: UInt -> UInt -> UInt
instance uintRing :: Ring UInt where
sub = uintSub
instance uintCommutativeRing :: CommutativeRing UInt
foreign import uintDiv :: UInt -> UInt -> UInt
foreign import uintMod :: UInt -> UInt -> UInt
foreign import uintDegree :: UInt -> Int
instance uintEuclideanRing :: EuclideanRing UInt where
div = uintDiv
mod = uintMod
degree = uintDegree
foreign import uintEq :: UInt -> UInt -> Boolean
instance uintEqInstance :: Eq UInt where
eq = uintEq
foreign import uintCmp :: Ordering -> Ordering -> Ordering -> UInt -> UInt -> Ordering
instance uintOrd :: Ord UInt where
compare = uintCmp LT EQ GT
foreign import fromStringImpl :: String -> Number
-- | Tries to parse an `UInt` from a `String`.
fromString :: String -> Maybe UInt
fromString = fromNumber' <<< fromStringImpl
-- | Converts an `UInt` to a `String`.
-- |
-- | There is also a `Show` instance (so you can use `show`), but that
-- | appends `u` suffix, which isn't always what you'll want.
-- |
-- | toString (fromInt 42) == "42"
-- | show (fromInt 42) == "42u"
foreign import toString :: UInt -> String
instance uintShowInstance :: Show UInt where
show u = toString u <> "u"
instance uintBounded :: Bounded UInt where
bottom = fromInt 0
top = fromInt (-1)
-- | Cast a `Number` `n` to `UInt` by performing 0-bit unsigned right
-- | shift `n >>> 0`.
fromNumber :: Number -> UInt
fromNumber = from
-- | Convert a `Number` which is already an `UInt` to `UInt`. Fails
-- | for non-integers and integers not in range from `0` to `2^32-1`.
fromNumber' :: Number -> Maybe UInt
fromNumber' = exact Just Nothing fromNumber
-- | Cast an `UInt` to a `Number`, which is always safe to do.
foreign import toNumber :: UInt -> Number
clamp' :: Number -> Number
clamp' = clamp (toNumber bottom) (toNumber top)
-- | Convert a `Number` to an `UInt`. Takes the closest integer equal to or
-- | less than the argument. Values outside the `UInt` range are clamped.
-- |
-- | > floor 27.1
-- | 27u
-- |
-- | > floor 27.9
-- | 27u
-- |
-- | > floor (-27.1)
-- | 0u
-- |
-- | > floor (1.0e65)
-- | 4294967295u
-- |
-- | > floor (-1.0e65)
-- | 0u
floor :: Number -> UInt
floor = fromNumber <<< Number.floor <<< clamp'
-- | Convert a `Number` to an `UInt`. Takes the closest integer equal to or
-- | greater than the argument. Values outside the `UInt` range are clamped.
-- |
-- | > ceil 27.1
-- | 28u
-- |
-- | > ceil 27.9
-- | 28u
-- |
-- | > ceil (-27.1)
-- | 0u
-- |
-- | > ceil (1.0e65)
-- | 4294967295u
-- |
-- | > ceil (-1.0e65)
-- | 0u
ceil :: Number -> UInt
ceil = fromNumber <<< Number.ceil <<< clamp'
-- | Convert a `Number` to an `UInt`, by taking the nearest integer to the
-- | argument. Values outside the `UInt` range are clamped.
-- |
-- | > round 27.1
-- | 27u
-- |
-- | > round 27.9
-- | 28u
-- |
-- | > round (-27.1)
-- | 0u
-- |
-- | > round (-27.9)
-- | 0u
-- |
-- | > round (1.0e65)
-- | 4294967295u
-- |
-- | > round (-1.0e65)
-- | 0u
round :: Number -> UInt
round = fromNumber <<< Number.round <<< clamp'
-- | Returns whether an `Int53` is an even number.
-- |
-- | > even (fromInt 0)
-- | true
-- |
-- | > even (fromInt 1)
-- | false
even :: UInt -> Boolean
even u = u `mod` (fromInt 2) == (fromInt 0)
-- | Returns whether an `Int53` is an odd number.
-- |
-- | > odd (fromInt 0)
-- | false
-- |
-- | > odd (fromInt 1)
-- | true
odd :: UInt -> Boolean
odd u = u `mod` (fromInt 2) == (fromInt 1)
-- | Raises the first argument to the power of the second argument (the exponent).
-- |
-- | > pow (fromInt 2) (fromInt 3)
-- | 8u
foreign import pow :: UInt -> UInt -> UInt
-- | Bitwise AND.
-- |
-- | > and (fromInt 6) (fromInt 4)
-- | 4u
foreign import and :: UInt -> UInt -> UInt
infixl 10 and as .&.
-- | Bitwise OR.
-- |
-- | > or (fromInt 4) (fromInt 2)
-- | 6u
foreign import or :: UInt -> UInt -> UInt
infixl 10 or as .|.
-- | Bitwise XOR.
-- |
-- | > xor (fromInt 6) (fromInt 4)
-- | 0u
foreign import xor :: UInt -> UInt -> UInt
infixl 10 xor as .^.
-- | Bitwise shift left.
-- |
-- | > shl (fromInt 4) (fromInt 1)
-- | 8u
foreign import shl :: UInt -> UInt -> UInt
-- | Bitwise shift right while preserving sign.
-- |
-- | > shr (fromInt 4) (fromInt 1)
-- | 2u
foreign import shr :: UInt -> UInt -> UInt
-- | Bitwise zero-fill shift right.
-- |
-- | > shr (fromInt 4) (fromInt 1)
-- | 2u
foreign import zshr :: UInt -> UInt -> UInt
-- | Bitwise NOT.
-- |
-- | > complement (fromInt 0xFF...)
-- | 0u
foreign import complement :: UInt -> UInt