Data/Int.hs

   1 {-# OPTIONS_GHC -fno-implicit-prelude #-}
   2 -----------------------------------------------------------------------------
   3 -- |
   4 -- Module      :  Data.Int
   5 -- Copyright   :  (c) The University of Glasgow 2001
   6 -- License     :  BSD-style (see the file libraries/base/LICENSE)
   7 --
   8 -- Maintainer  :  libraries@haskell.org
   9 -- Stability   :  experimental
  10 -- Portability :  portable
  11 --
  12 -- Signed integer types
  13 --
  14 -----------------------------------------------------------------------------
  15
  16 module Data.Int
  17   (
  18         -- * Signed integer types
  19         Int,
  20         Int8, Int16, Int32, Int64,
  21
  22         -- * Notes
  23
  24         -- $notes
  25         ) where
  26
  27 #ifdef __GLASGOW_HASKELL__
  28 import GHC.Base ( Int )
  29 import GHC.Int  ( Int8, Int16, Int32, Int64 )
  30 #endif
  31
  32 #ifdef __HUGS__
  33 import Hugs.Int ( Int8, Int16, Int32, Int64 )
  34 #endif
  35
  36 #ifdef __NHC__
  37 import Prelude
  38 import Prelude (Int)
  39 import NHC.FFI (Int8, Int16, Int32, Int64)
  40 import NHC.SizedTypes (Int8, Int16, Int32, Int64)       -- instances of Bits
  41 #endif
  42
  43 {- $notes
  44
  45 * All arithmetic is performed modulo 2^n, where @n@ is the number of
  46   bits in the type.
  47
  48 * For coercing between any two integer types, use 'Prelude.fromIntegral',
  49   which is specialized for all the common cases so should be fast
  50   enough.  Coercing word types (see "Data.Word") to and from integer
  51   types preserves representation, not sign.
  52
  53 * The rules that hold for 'Prelude.Enum' instances over a
  54   bounded type such as 'Int' (see the section of the
  55   Haskell report dealing with arithmetic sequences) also hold for the
  56   'Prelude.Enum' instances over the various
  57   'Int' types defined here.
  58
  59 * Right and left shifts by amounts greater than or equal to the width
  60   of the type result in either zero or -1, depending on the sign of
  61   the value being shifted.  This is contrary to the behaviour in C,
  62   which is undefined; a common interpretation is to truncate the shift
  63   count to the width of the type, for example @1 \<\< 32
  64   == 1@ in some C implementations.
  65 -}