[project @ 2001-12-21 15:07:20 by simonmar]
[packages/base.git] / GHC / Num.lhs
1 % ------------------------------------------------------------------------------
2 % $Id: Num.lhs,v 1.3 2001/12/21 15:07:25 simonmar Exp $
3 %
4 % (c) The University of Glasgow, 1994-2000
5 %
6
7 \section[GHC.Num]{Module @GHC.Num@}
8
9 The class
10
11         Num
12
13 and the type
14
15         Integer
16
17
18 \begin{code}
19 {-# OPTIONS -fno-implicit-prelude #-}
20
21 #include "MachDeps.h"
22 #if SIZEOF_HSWORD == 4
23 #define LEFTMOST_BIT 2147483648
24 #elif SIZEOF_HSWORD == 8
25 #define LEFTMOST_BIT 9223372036854775808
26 #else
27 #error Please define LEFTMOST_BIT to be 2^(SIZEOF_HSWORD*8-1)
28 #endif
29
30 module GHC.Num where
31
32 import {-# SOURCE #-} GHC.Err
33 import GHC.Base
34 import GHC.List
35 import GHC.Enum
36 import GHC.Show
37
38 infixl 7  *
39 infixl 6  +, -
40
41 default ()              -- Double isn't available yet, 
42                         -- and we shouldn't be using defaults anyway
43 \end{code}
44
45 %*********************************************************
46 %*                                                      *
47 \subsection{Standard numeric class}
48 %*                                                      *
49 %*********************************************************
50
51 \begin{code}
52 class  (Eq a, Show a) => Num a  where
53     (+), (-), (*)       :: a -> a -> a
54     negate              :: a -> a
55     abs, signum         :: a -> a
56     fromInteger         :: Integer -> a
57
58     x - y               = x + negate y
59     negate x            = 0 - x
60
61 {-# INLINE subtract #-}
62 subtract :: (Num a) => a -> a -> a
63 subtract x y = y - x
64 \end{code}
65
66
67 %*********************************************************
68 %*                                                      *
69 \subsection{Instances for @Int@}
70 %*                                                      *
71 %*********************************************************
72
73 \begin{code}
74 instance  Num Int  where
75     (+)    = plusInt
76     (-)    = minusInt
77     negate = negateInt
78     (*)    = timesInt
79     abs n  = if n `geInt` 0 then n else negateInt n
80
81     signum n | n `ltInt` 0 = negateInt 1
82              | n `eqInt` 0 = 0
83              | otherwise   = 1
84
85     fromInteger = integer2Int
86 \end{code}
87
88
89 \begin{code}
90 -- These can't go in GHC.Base with the defn of Int, because
91 -- we don't have pairs defined at that time!
92
93 quotRemInt :: Int -> Int -> (Int, Int)
94 a@(I# _) `quotRemInt` b@(I# _) = (a `quotInt` b, a `remInt` b)
95     -- OK, so I made it a little stricter.  Shoot me.  (WDP 94/10)
96
97 divModInt ::  Int -> Int -> (Int, Int)
98 divModInt x@(I# _) y@(I# _) = (x `divInt` y, x `modInt` y)
99     -- Stricter.  Sorry if you don't like it.  (WDP 94/10)
100 \end{code}
101
102
103 %*********************************************************
104 %*                                                      *
105 \subsection{The @Integer@ type}
106 %*                                                      *
107 %*********************************************************
108
109 \begin{code}
110 data Integer    
111    = S# Int#                            -- small integers
112 #ifndef ILX
113    | J# Int# ByteArray#                 -- large integers
114 #else
115    | J# Void BigInteger                 -- .NET big ints
116
117 foreign type dotnet "BigInteger" BigInteger
118 #endif
119 \end{code}
120
121 Convenient boxed Integer PrimOps. 
122
123 \begin{code}
124 zeroInteger :: Integer
125 zeroInteger = S# 0#
126
127 int2Integer :: Int -> Integer
128 {-# INLINE int2Integer #-}
129 int2Integer (I# i) = S# i
130
131 integer2Int :: Integer -> Int
132 integer2Int (S# i)   = I# i
133 integer2Int (J# s d) = case (integer2Int# s d) of { n# -> I# n# }
134
135 toBig (S# i)     = case int2Integer# i of { (# s, d #) -> J# s d }
136 toBig i@(J# _ _) = i
137 \end{code}
138
139
140 %*********************************************************
141 %*                                                      *
142 \subsection{Dividing @Integers@}
143 %*                                                      *
144 %*********************************************************
145
146 \begin{code}
147 quotRemInteger :: Integer -> Integer -> (Integer, Integer)
148 quotRemInteger a@(S# (-LEFTMOST_BIT#)) b = quotRemInteger (toBig a) b
149 quotRemInteger (S# i) (S# j)
150   = case quotRemInt (I# i) (I# j) of ( I# i, I# j ) -> ( S# i, S# j ) 
151 quotRemInteger i1@(J# _ _) i2@(S# _) = quotRemInteger i1 (toBig i2)
152 quotRemInteger i1@(S# _) i2@(J# _ _) = quotRemInteger (toBig i1) i2
153 quotRemInteger (J# s1 d1) (J# s2 d2)
154   = case (quotRemInteger# s1 d1 s2 d2) of
155           (# s3, d3, s4, d4 #)
156             -> (J# s3 d3, J# s4 d4)
157
158 divModInteger a@(S# (-LEFTMOST_BIT#)) b = divModInteger (toBig a) b
159 divModInteger (S# i) (S# j)
160   = case divModInt (I# i) (I# j) of ( I# i, I# j ) -> ( S# i, S# j) 
161 divModInteger i1@(J# _ _) i2@(S# _) = divModInteger i1 (toBig i2)
162 divModInteger i1@(S# _) i2@(J# _ _) = divModInteger (toBig i1) i2
163 divModInteger (J# s1 d1) (J# s2 d2)
164   = case (divModInteger# s1 d1 s2 d2) of
165           (# s3, d3, s4, d4 #)
166             -> (J# s3 d3, J# s4 d4)
167
168 remInteger :: Integer -> Integer -> Integer
169 remInteger ia 0
170   = error "Prelude.Integral.rem{Integer}: divide by 0"
171 remInteger a@(S# (-LEFTMOST_BIT#)) b = remInteger (toBig a) b
172 remInteger (S# a) (S# b) = S# (remInt# a b)
173 {- Special case doesn't work, because a 1-element J# has the range
174    -(2^32-1) -- 2^32-1, whereas S# has the range -2^31 -- (2^31-1)
175 remInteger ia@(S# a) (J# sb b)
176   | sb ==# 1#  = S# (remInt# a (word2Int# (integer2Word# sb b)))
177   | sb ==# -1# = S# (remInt# a (0# -# (word2Int# (integer2Word# sb b))))
178   | 0# <# sb   = ia
179   | otherwise  = S# (0# -# a)
180 -}
181 remInteger ia@(S# _) ib@(J# _ _) = remInteger (toBig ia) ib
182 remInteger (J# sa a) (S# b)
183   = case int2Integer# b of { (# sb, b #) ->
184     case remInteger# sa a sb b of { (# sr, r #) ->
185     S# (integer2Int# sr r) }}
186 remInteger (J# sa a) (J# sb b)
187   = case remInteger# sa a sb b of (# sr, r #) -> J# sr r
188
189 quotInteger :: Integer -> Integer -> Integer
190 quotInteger ia 0
191   = error "Prelude.Integral.quot{Integer}: divide by 0"
192 quotInteger a@(S# (-LEFTMOST_BIT#)) b = quotInteger (toBig a) b
193 quotInteger (S# a) (S# b) = S# (quotInt# a b)
194 {- Special case disabled, see remInteger above
195 quotInteger (S# a) (J# sb b)
196   | sb ==# 1#  = S# (quotInt# a (word2Int# (integer2Word# sb b)))
197   | sb ==# -1# = S# (quotInt# a (0# -# (word2Int# (integer2Word# sb b))))
198   | otherwise  = zeroInteger
199 -}
200 quotInteger ia@(S# _) ib@(J# _ _) = quotInteger (toBig ia) ib
201 quotInteger (J# sa a) (S# b)
202   = case int2Integer# b of { (# sb, b #) ->
203     case quotInteger# sa a sb b of (# sq, q #) -> J# sq q }
204 quotInteger (J# sa a) (J# sb b)
205   = case quotInteger# sa a sb b of (# sg, g #) -> J# sg g
206 \end{code}
207
208
209
210 \begin{code}
211 gcdInteger :: Integer -> Integer -> Integer
212 -- SUP: Do we really need the first two cases?
213 gcdInteger a@(S# (-LEFTMOST_BIT#)) b = gcdInteger (toBig a) b
214 gcdInteger a b@(S# (-LEFTMOST_BIT#)) = gcdInteger a (toBig b)
215 gcdInteger (S# a) (S# b) = case gcdInt (I# a) (I# b) of { I# c -> S# c }
216 gcdInteger ia@(S# 0#) ib@(J# 0# _) = error "GHC.Num.gcdInteger: gcd 0 0 is undefined"
217 gcdInteger ia@(S# a)  ib@(J# sb b)
218   | a  ==# 0#  = abs ib
219   | sb ==# 0#  = abs ia
220   | otherwise  = S# (gcdIntegerInt# absSb b absA)
221        where absA  = if a  <# 0# then negateInt# a  else a
222              absSb = if sb <# 0# then negateInt# sb else sb
223 gcdInteger ia@(J# _ _) ib@(S# _) = gcdInteger ib ia
224 gcdInteger (J# 0# _) (J# 0# _) = error "GHC.Num.gcdInteger: gcd 0 0 is undefined"
225 gcdInteger (J# sa a) (J# sb b)
226   = case gcdInteger# sa a sb b of (# sg, g #) -> J# sg g
227
228 lcmInteger :: Integer -> Integer -> Integer
229 lcmInteger a 0
230   = zeroInteger
231 lcmInteger 0 b
232   = zeroInteger
233 lcmInteger a b
234   = (divExact aa (gcdInteger aa ab)) * ab
235   where aa = abs a
236         ab = abs b
237
238 divExact :: Integer -> Integer -> Integer
239 divExact a@(S# (-LEFTMOST_BIT#)) b = divExact (toBig a) b
240 divExact (S# a) (S# b) = S# (quotInt# a b)
241 divExact (S# a) (J# sb b)
242   = S# (quotInt# a (integer2Int# sb b))
243 divExact (J# sa a) (S# b)
244   = case int2Integer# b of
245      (# sb, b #) -> case divExactInteger# sa a sb b of (# sd, d #) -> J# sd d
246 divExact (J# sa a) (J# sb b)
247   = case divExactInteger# sa a sb b of (# sd, d #) -> J# sd d
248 \end{code}
249
250
251 %*********************************************************
252 %*                                                      *
253 \subsection{The @Integer@ instances for @Eq@, @Ord@}
254 %*                                                      *
255 %*********************************************************
256
257 \begin{code}
258 instance  Eq Integer  where
259     (S# i)     ==  (S# j)     = i ==# j
260     (S# i)     ==  (J# s d)   = cmpIntegerInt# s d i ==# 0#
261     (J# s d)   ==  (S# i)     = cmpIntegerInt# s d i ==# 0#
262     (J# s1 d1) ==  (J# s2 d2) = (cmpInteger# s1 d1 s2 d2) ==# 0#
263
264     (S# i)     /=  (S# j)     = i /=# j
265     (S# i)     /=  (J# s d)   = cmpIntegerInt# s d i /=# 0#
266     (J# s d)   /=  (S# i)     = cmpIntegerInt# s d i /=# 0#
267     (J# s1 d1) /=  (J# s2 d2) = (cmpInteger# s1 d1 s2 d2) /=# 0#
268
269 ------------------------------------------------------------------------
270 instance  Ord Integer  where
271     (S# i)     <=  (S# j)     = i <=# j
272     (J# s d)   <=  (S# i)     = cmpIntegerInt# s d i <=# 0#
273     (S# i)     <=  (J# s d)   = cmpIntegerInt# s d i >=# 0#
274     (J# s1 d1) <=  (J# s2 d2) = (cmpInteger# s1 d1 s2 d2) <=# 0#
275
276     (S# i)     >   (S# j)     = i ># j
277     (J# s d)   >   (S# i)     = cmpIntegerInt# s d i ># 0#
278     (S# i)     >   (J# s d)   = cmpIntegerInt# s d i <# 0#
279     (J# s1 d1) >   (J# s2 d2) = (cmpInteger# s1 d1 s2 d2) ># 0#
280
281     (S# i)     <   (S# j)     = i <# j
282     (J# s d)   <   (S# i)     = cmpIntegerInt# s d i <# 0#
283     (S# i)     <   (J# s d)   = cmpIntegerInt# s d i ># 0#
284     (J# s1 d1) <   (J# s2 d2) = (cmpInteger# s1 d1 s2 d2) <# 0#
285
286     (S# i)     >=  (S# j)     = i >=# j
287     (J# s d)   >=  (S# i)     = cmpIntegerInt# s d i >=# 0#
288     (S# i)     >=  (J# s d)   = cmpIntegerInt# s d i <=# 0#
289     (J# s1 d1) >=  (J# s2 d2) = (cmpInteger# s1 d1 s2 d2) >=# 0#
290
291     compare (S# i)  (S# j)
292        | i ==# j = EQ
293        | i <=# j = LT
294        | otherwise = GT
295     compare (J# s d) (S# i)
296        = case cmpIntegerInt# s d i of { res# ->
297          if res# <# 0# then LT else 
298          if res# ># 0# then GT else EQ
299          }
300     compare (S# i) (J# s d)
301        = case cmpIntegerInt# s d i of { res# ->
302          if res# ># 0# then LT else 
303          if res# <# 0# then GT else EQ
304          }
305     compare (J# s1 d1) (J# s2 d2)
306        = case cmpInteger# s1 d1 s2 d2 of { res# ->
307          if res# <# 0# then LT else 
308          if res# ># 0# then GT else EQ
309          }
310 \end{code}
311
312
313 %*********************************************************
314 %*                                                      *
315 \subsection{The @Integer@ instances for @Num@}
316 %*                                                      *
317 %*********************************************************
318
319 \begin{code}
320 instance  Num Integer  where
321     (+) = plusInteger
322     (-) = minusInteger
323     (*) = timesInteger
324     negate         = negateInteger
325     fromInteger x  =  x
326
327     -- ORIG: abs n = if n >= 0 then n else -n
328     abs (S# (-LEFTMOST_BIT#)) = LEFTMOST_BIT
329     abs (S# i) = case abs (I# i) of I# j -> S# j
330     abs n@(J# s d) = if (s >=# 0#) then n else J# (negateInt# s) d
331
332     signum (S# i) = case signum (I# i) of I# j -> S# j
333     signum (J# s d)
334       = let
335             cmp = cmpIntegerInt# s d 0#
336         in
337         if      cmp >#  0# then S# 1#
338         else if cmp ==# 0# then S# 0#
339         else                    S# (negateInt# 1#)
340
341 plusInteger i1@(S# i) i2@(S# j)  = case addIntC# i j of { (# r, c #) ->
342                                    if c ==# 0# then S# r
343                                    else toBig i1 + toBig i2 }
344 plusInteger i1@(J# _ _) i2@(S# _) = i1 + toBig i2
345 plusInteger i1@(S# _) i2@(J# _ _) = toBig i1 + i2
346 plusInteger (J# s1 d1) (J# s2 d2) = case plusInteger# s1 d1 s2 d2 of (# s, d #) -> J# s d
347
348 minusInteger i1@(S# i) i2@(S# j)   = case subIntC# i j of { (# r, c #) ->
349                                      if c ==# 0# then S# r
350                                      else toBig i1 - toBig i2 }
351 minusInteger i1@(J# _ _) i2@(S# _) = i1 - toBig i2
352 minusInteger i1@(S# _) i2@(J# _ _) = toBig i1 - i2
353 minusInteger (J# s1 d1) (J# s2 d2) = case minusInteger# s1 d1 s2 d2 of (# s, d #) -> J# s d
354
355 timesInteger i1@(S# i) i2@(S# j)   = if   mulIntMayOflo# i j ==# 0#
356                                      then S# (i *# j)
357                                      else toBig i1 * toBig i2 
358 timesInteger i1@(J# _ _) i2@(S# _) = i1 * toBig i2
359 timesInteger i1@(S# _) i2@(J# _ _) = toBig i1 * i2
360 timesInteger (J# s1 d1) (J# s2 d2) = case timesInteger# s1 d1 s2 d2 of (# s, d #) -> J# s d
361
362 negateInteger (S# (-LEFTMOST_BIT#)) = LEFTMOST_BIT
363 negateInteger (S# i)              = S# (negateInt# i)
364 negateInteger (J# s d)            = J# (negateInt# s) d
365 \end{code}
366
367
368 %*********************************************************
369 %*                                                      *
370 \subsection{The @Integer@ instance for @Enum@}
371 %*                                                      *
372 %*********************************************************
373
374 \begin{code}
375 instance  Enum Integer  where
376     succ x               = x + 1
377     pred x               = x - 1
378     toEnum n             = int2Integer n
379     fromEnum n           = integer2Int n
380
381     {-# INLINE enumFrom #-}
382     {-# INLINE enumFromThen #-}
383     {-# INLINE enumFromTo #-}
384     {-# INLINE enumFromThenTo #-}
385     enumFrom x             = efdInteger  x 1
386     enumFromThen x y       = efdInteger  x (y-x)
387     enumFromTo x lim       = efdtInteger x 1     lim
388     enumFromThenTo x y lim = efdtInteger x (y-x) lim
389
390
391 efdInteger  = enumDeltaIntegerList
392 efdtInteger = enumDeltaToIntegerList
393
394 {-# RULES
395 "efdInteger"            forall x y.  efdInteger x y         = build (\c _ -> enumDeltaIntegerFB c x y)
396 "efdtInteger"           forall x y l.efdtInteger x y l      = build (\c n -> enumDeltaToIntegerFB c n x y l)
397 "enumDeltaInteger"      enumDeltaIntegerFB   (:)    = enumDeltaIntegerList
398 "enumDeltaToInteger"    enumDeltaToIntegerFB (:) [] = enumDeltaToIntegerList
399  #-}
400
401 enumDeltaIntegerFB :: (Integer -> b -> b) -> Integer -> Integer -> b
402 enumDeltaIntegerFB c x d = x `c` enumDeltaIntegerFB c (x+d) d
403
404 enumDeltaIntegerList :: Integer -> Integer -> [Integer]
405 enumDeltaIntegerList x d = x : enumDeltaIntegerList (x+d) d
406
407 enumDeltaToIntegerFB c n x delta lim
408   | delta >= 0 = up_fb c n x delta lim
409   | otherwise  = dn_fb c n x delta lim
410
411 enumDeltaToIntegerList x delta lim
412   | delta >= 0 = up_list x delta lim
413   | otherwise  = dn_list x delta lim
414
415 up_fb c n x delta lim = go (x::Integer)
416                       where
417                         go x | x > lim   = n
418                              | otherwise = x `c` go (x+delta)
419 dn_fb c n x delta lim = go (x::Integer)
420                       where
421                         go x | x < lim   = n
422                              | otherwise = x `c` go (x+delta)
423
424 up_list x delta lim = go (x::Integer)
425                     where
426                         go x | x > lim   = []
427                              | otherwise = x : go (x+delta)
428 dn_list x delta lim = go (x::Integer)
429                     where
430                         go x | x < lim   = []
431                              | otherwise = x : go (x+delta)
432
433 \end{code}
434
435
436 %*********************************************************
437 %*                                                      *
438 \subsection{The @Integer@ instances for @Show@}
439 %*                                                      *
440 %*********************************************************
441
442 \begin{code}
443 instance Show Integer where
444     showsPrec p n r
445         | p > 6 && n < 0 = '(' : jtos n (')' : r)
446                 -- Minor point: testing p first gives better code 
447                 -- in the not-uncommon case where the p argument
448                 -- is a constant
449         | otherwise      = jtos n r
450     showList = showList__ (showsPrec 0)
451
452 jtos :: Integer -> String -> String
453 jtos n cs
454     | n < 0     = '-' : jtos' (-n) cs
455     | otherwise = jtos' n cs
456     where
457     jtos' :: Integer -> String -> String
458     jtos' n' cs'
459         | n' < 10    = case unsafeChr (ord '0' + fromInteger n') of
460             c@(C# _) -> c:cs'
461         | otherwise = case unsafeChr (ord '0' + fromInteger r) of
462             c@(C# _) -> jtos' q (c:cs')
463         where
464         (q,r) = n' `quotRemInteger` 10
465 \end{code}