GHC/Num.lhs

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