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 (S# i) (S# j)
 148   = case quotRemInt (I# i) (I# j) of ( I# i, I# j ) -> ( S# i, S# j )
 149 quotRemInteger i1@(J# _ _) i2@(S# _) = quotRemInteger i1 (toBig i2)
 150 quotRemInteger i1@(S# _) i2@(J# _ _) = quotRemInteger (toBig i1) i2
 151 quotRemInteger (J# s1 d1) (J# s2 d2)
 152   = case (quotRemInteger# s1 d1 s2 d2) of
 153           (# s3, d3, s4, d4 #)
 154             -> (J# s3 d3, J# s4 d4)
 155
 156 divModInteger (S# i) (S# j)
 157   = case divModInt (I# i) (I# j) of ( I# i, I# j ) -> ( S# i, S# j)
 158 divModInteger i1@(J# _ _) i2@(S# _) = divModInteger i1 (toBig i2)
 159 divModInteger i1@(S# _) i2@(J# _ _) = divModInteger (toBig i1) i2
 160 divModInteger (J# s1 d1) (J# s2 d2)
 161   = case (divModInteger# s1 d1 s2 d2) of
 162           (# s3, d3, s4, d4 #)
 163             -> (J# s3 d3, J# s4 d4)
 164
 165 remInteger :: Integer -> Integer -> Integer
 166 remInteger ia 0
 167   = error "Prelude.Integral.rem{Integer}: divide by 0"
 168 remInteger (S# a) (S# b)
 169   = S# (remInt# a b)
 170 remInteger ia@(S# a) (J# sb b)
 171   | sb ==# 1#  = S# (remInt# a (word2Int# (integer2Word# sb b)))
 172   | sb ==# -1# = S# (remInt# a (0# -# (word2Int# (integer2Word# sb b))))
 173   | 0# <# sb   = ia
 174   | otherwise  = S# (0# -# a)
 175 remInteger (J# sa a) (S# b)
 176   = case int2Integer# b of { (# sb, b #) ->
 177     case remInteger# sa a sb b of { (# sr, r #) ->
 178     S# (sr *# (word2Int# (integer2Word# sr r))) }}
 179 remInteger (J# sa a) (J# sb b)
 180   = case remInteger# sa a sb b of (# sr, r #) -> J# sr r
 181
 182 quotInteger :: Integer -> Integer -> Integer
 183 quotInteger ia 0
 184   = error "Prelude.Integral.quot{Integer}: divide by 0"
 185 quotInteger (S# a) (S# b)
 186   = S# (quotInt# a b)
 187 quotInteger (S# a) (J# sb b)
 188   | sb ==# 1#  = S# (quotInt# a (word2Int# (integer2Word# sb b)))
 189   | sb ==# -1# = S# (quotInt# a (0# -# (word2Int# (integer2Word# sb b))))
 190   | otherwise  = zeroInteger
 191 quotInteger (J# sa a) (S# b)
 192   = case int2Integer# b of { (# sb, b #) ->
 193     case quotInteger# sa a sb b of (# sq, q #) -> J# sq q }
 194 quotInteger (J# sa a) (J# sb b)
 195   = case quotInteger# sa a sb b of (# sg, g #) -> J# sg g
 196 \end{code}
 197
 198
 199
 200 \begin{code}
 201 gcdInteger :: Integer -> Integer -> Integer
 202 gcdInteger (S# a) (S# b)
 203   = case gcdInt# a b of g -> S# g
 204 gcdInteger ia@(S# a) ib@(J# sb b)
 205   | a  ==# 0#  = abs ib
 206   | sb ==# 0#  = abs ia
 207   | otherwise  = case gcdIntegerInt# sb b a of g -> S# g
 208 gcdInteger ia@(J# sa a) ib@(S# b)
 209   | sa ==# 0#  = abs ib
 210   | b ==# 0#   = abs ia
 211   | otherwise  = case gcdIntegerInt# sa a b of g -> S# g
 212 gcdInteger (J# sa a) (J# sb b)
 213   = case gcdInteger# sa a sb b of (# sg, g #) -> J# sg g
 214
 215 lcmInteger :: Integer -> Integer -> Integer
 216 lcmInteger a 0
 217   = zeroInteger
 218 lcmInteger 0 b
 219   = zeroInteger
 220 lcmInteger a b
 221   = (divExact aa (gcdInteger aa ab)) * ab
 222   where aa = abs a
 223         ab = abs b
 224
 225 divExact :: Integer -> Integer -> Integer
 226 divExact (S# a) (S# b)
 227   = S# (quotInt# a b)
 228 divExact (S# a) (J# sb b)
 229   = S# (quotInt# a (sb *# (word2Int# (integer2Word# sb b))))
 230 divExact (J# sa a) (S# b)
 231   = case int2Integer# b of
 232      (# sb, b #) -> case divExactInteger# sa a sb b of (# sd, d #) -> J# sd d
 233 divExact (J# sa a) (J# sb b)
 234   = case divExactInteger# sa a sb b of (# sd, d #) -> J# sd d
 235 \end{code}
 236
 237
 238 %*********************************************************
 239 %*                                                      *
 240 \subsection{The @Integer@ instances for @Eq@, @Ord@}
 241 %*                                                      *
 242 %*********************************************************
 243
 244 \begin{code}
 245 instance  Eq Integer  where
 246     (S# i)     ==  (S# j)     = i ==# j
 247     (S# i)     ==  (J# s d)   = cmpIntegerInt# s d i ==# 0#
 248     (J# s d)   ==  (S# i)     = cmpIntegerInt# s d i ==# 0#
 249     (J# s1 d1) ==  (J# s2 d2) = (cmpInteger# s1 d1 s2 d2) ==# 0#
 250
 251     (S# i)     /=  (S# j)     = i /=# j
 252     (S# i)     /=  (J# s d)   = cmpIntegerInt# s d i /=# 0#
 253     (J# s d)   /=  (S# i)     = cmpIntegerInt# s d i /=# 0#
 254     (J# s1 d1) /=  (J# s2 d2) = (cmpInteger# s1 d1 s2 d2) /=# 0#
 255
 256 ------------------------------------------------------------------------
 257 instance  Ord Integer  where
 258     (S# i)     <=  (S# j)     = i <=# j
 259     (J# s d)   <=  (S# i)     = cmpIntegerInt# s d i <=# 0#
 260     (S# i)     <=  (J# s d)   = 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     (J# s d)   >   (S# i)     = cmpIntegerInt# s d i ># 0#
 265     (S# i)     >   (J# s d)   = cmpIntegerInt# s d i <# 0#
 266     (J# s1 d1) >   (J# s2 d2) = (cmpInteger# s1 d1 s2 d2) ># 0#
 267
 268     (S# i)     <   (S# j)     = i <# j
 269     (J# s d)   <   (S# i)     = cmpIntegerInt# s d i <# 0#
 270     (S# i)     <   (J# s d)   = cmpIntegerInt# s d i ># 0#
 271     (J# s1 d1) <   (J# s2 d2) = (cmpInteger# s1 d1 s2 d2) <# 0#
 272
 273     (S# i)     >=  (S# j)     = i >=# j
 274     (J# s d)   >=  (S# i)     = cmpIntegerInt# s d i >=# 0#
 275     (S# i)     >=  (J# s d)   = cmpIntegerInt# s d i <=# 0#
 276     (J# s1 d1) >=  (J# s2 d2) = (cmpInteger# s1 d1 s2 d2) >=# 0#
 277
 278     compare (S# i)  (S# j)
 279        | i ==# j = EQ
 280        | i <=# j = LT
 281        | otherwise = GT
 282     compare (J# s d) (S# i)
 283        = case cmpIntegerInt# s d i of { res# ->
 284          if res# <# 0# then LT else
 285          if res# ># 0# then GT else EQ
 286          }
 287     compare (S# i) (J# s d)
 288        = case cmpIntegerInt# s d i of { res# ->
 289          if res# ># 0# then LT else
 290          if res# <# 0# then GT else EQ
 291          }
 292     compare (J# s1 d1) (J# s2 d2)
 293        = case cmpInteger# s1 d1 s2 d2 of { res# ->
 294          if res# <# 0# then LT else
 295          if res# ># 0# then GT else EQ
 296          }
 297 \end{code}
 298
 299
 300 %*********************************************************
 301 %*                                                      *
 302 \subsection{The @Integer@ instances for @Num@}
 303 %*                                                      *
 304 %*********************************************************
 305
 306 \begin{code}
 307 instance  Num Integer  where
 308     (+) i1@(S# i) i2@(S# j)
 309         = case addIntC# i j of { (# r, c #) ->
 310           if c ==# 0# then S# r
 311           else toBig i1 + toBig i2 }
 312     (+) i1@(J# _ _) i2@(S# _)   = i1 + toBig i2
 313     (+) i1@(S# _) i2@(J# _ _)   = toBig i1 + i2
 314     (+) (J# s1 d1) (J# s2 d2)
 315       = case plusInteger# s1 d1 s2 d2 of (# s, d #) -> J# s d
 316
 317     (-) i1@(S# i) i2@(S# j)
 318         = case subIntC# i j of { (# r, c #) ->
 319           if c ==# 0# then S# r
 320           else toBig i1 - toBig i2 }
 321     (-) i1@(J# _ _) i2@(S# _)   = i1 - toBig i2
 322     (-) i1@(S# _) i2@(J# _ _)   = toBig i1 - i2
 323     (-) (J# s1 d1) (J# s2 d2)
 324       = case minusInteger# s1 d1 s2 d2 of (# s, d #) -> J# s d
 325
 326     (*) i1@(S# i) i2@(S# j)
 327         = case mulIntC# i j of { (# r, c #) ->
 328           if c ==# 0# then S# r
 329           else toBig i1 * toBig i2 }
 330     (*) i1@(J# _ _) i2@(S# _)   = i1 * toBig i2
 331     (*) i1@(S# _) i2@(J# _ _)   = toBig i1 * i2
 332     (*) (J# s1 d1) (J# s2 d2)
 333       = case timesInteger# s1 d1 s2 d2 of (# s, d #) -> J# s d
 334
 335     negate (S# (-2147483648#)) = 2147483648
 336     negate (S# i) = S# (negateInt# i)
 337     negate (J# s d) = J# (negateInt# s) d
 338
 339     -- ORIG: abs n = if n >= 0 then n else -n
 340
 341     abs (S# (-2147483648#)) = 2147483648
 342     abs (S# i) = case abs (I# i) of I# j -> S# j
 343     abs n@(J# s d) = if (s >=# 0#) then n else J# (negateInt# s) d
 344
 345     signum (S# i) = case signum (I# i) of I# j -> S# j
 346     signum (J# s d)
 347       = let
 348             cmp = cmpIntegerInt# s d 0#
 349         in
 350         if      cmp >#  0# then S# 1#
 351         else if cmp ==# 0# then S# 0#
 352         else                    S# (negateInt# 1#)
 353
 354     fromInteger x       =  x
 355
 356     fromInt (I# i)      =  S# i
 357 \end{code}
 358
 359
 360 %*********************************************************
 361 %*                                                      *
 362 \subsection{The @Integer@ instance for @Enum@}
 363 %*                                                      *
 364 %*********************************************************
 365
 366 \begin{code}
 367 instance  Enum Integer  where
 368     succ x               = x + 1
 369     pred x               = x - 1
 370     toEnum n             = int2Integer n
 371     fromEnum n           = integer2Int n
 372
 373     {-# INLINE enumFrom #-}
 374     {-# INLINE enumFromThen #-}
 375     {-# INLINE enumFromTo #-}
 376     {-# INLINE enumFromThenTo #-}
 377     enumFrom x             = build (\c _ -> enumDeltaIntegerFB   c   x 1)
 378     enumFromThen x y       = build (\c _ -> enumDeltaIntegerFB   c   x (y-x))
 379     enumFromTo x lim       = build (\c n -> enumDeltaToIntegerFB c n x 1     lim)
 380     enumFromThenTo x y lim = build (\c n -> enumDeltaToIntegerFB c n x (y-x) lim)
 381
 382 enumDeltaIntegerFB :: (Integer -> b -> b) -> Integer -> Integer -> b
 383 enumDeltaIntegerFB c x d = x `c` enumDeltaIntegerFB c (x+d) d
 384
 385 enumDeltaIntegerList :: Integer -> Integer -> [Integer]
 386 enumDeltaIntegerList x d = x : enumDeltaIntegerList (x+d) d
 387
 388 enumDeltaToIntegerFB c n x delta lim
 389   | delta >= 0 = up_fb c n x delta lim
 390   | otherwise  = dn_fb c n x delta lim
 391
 392 enumDeltaToIntegerList x delta lim
 393   | delta >= 0 = up_list x delta lim
 394   | otherwise  = dn_list x delta lim
 395
 396 up_fb c n x delta lim = go (x::Integer)
 397                       where
 398                         go x | x > lim   = n
 399                              | otherwise = x `c` go (x+delta)
 400 dn_fb c n x delta lim = go (x::Integer)
 401                       where
 402                         go x | x < lim   = n
 403                              | otherwise = x `c` go (x+delta)
 404
 405 up_list x delta lim = go (x::Integer)
 406                     where
 407                         go x | x > lim   = []
 408                              | otherwise = x : go (x+delta)
 409 dn_list x delta lim = go (x::Integer)
 410                     where
 411                         go x | x < lim   = []
 412                              | otherwise = x : go (x+delta)
 413
 414 {-# RULES
 415 "enumDeltaInteger"      enumDeltaIntegerFB   (:)    = enumDeltaIntegerList
 416 "enumDeltaToInteger"    enumDeltaToIntegerFB (:) [] = enumDeltaToIntegerList
 417  #-}
 418 \end{code}
 419
 420
 421 %*********************************************************
 422 %*                                                      *
 423 \subsection{The @Integer@ instances for @Show@}
 424 %*                                                      *
 425 %*********************************************************
 426
 427 \begin{code}
 428 instance  Show Integer  where
 429     showsPrec   x = showSignedInteger x
 430     showList = showList__ (showsPrec 0)
 431
 432 showSignedInteger :: Int -> Integer -> ShowS
 433 showSignedInteger p n r
 434   | n < 0 && p > 6 = '(':jtos n (')':r)
 435   | otherwise      = jtos n r
 436
 437 jtos :: Integer -> String -> String
 438 jtos i rs
 439  | i < 0     = '-' : jtos' (-i) rs
 440  | otherwise = jtos' i rs
 441  where
 442   jtos' :: Integer -> String -> String
 443   jtos' n cs
 444    | n < 10    = chr (fromInteger n + (ord_0::Int)) : cs
 445    | otherwise = jtos' q (chr (integer2Int r + (ord_0::Int)) : cs)
 446     where
 447      (q,r) = n `quotRemInteger` 10
 448 \end{code}