ghc/lib/std/PrelNum.lhs

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