Copyright	(c) Herbert Valerio Riedel 2014
License	BSD3
Maintainer	ghc-devs@haskell.org
Stability	provisional
Portability	non-portable (GHC Extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

GHC.Integer.GMP.Internals

Contents

The Integer type
The BigNat type
Import/export functions

Description

Synopsis

data Integer where
- pattern S# :: Int# -> Integer
- pattern Jn# :: BigNat -> Integer
- pattern Jp# :: BigNat -> Integer
isValidInteger# :: Integer -> Int#
module GHC.Integer
gcdInteger :: Integer -> Integer -> Integer
gcdExtInteger :: Integer -> Integer -> (# Integer, Integer #)
lcmInteger :: Integer -> Integer -> Integer
sqrInteger :: Integer -> Integer
powModInteger :: Integer -> Integer -> Integer -> Integer
recipModInteger :: Integer -> Integer -> Integer
wordToNegInteger :: Word# -> Integer
bigNatToInteger :: BigNat -> Integer
bigNatToNegInteger :: BigNat -> Integer
data BigNat = BN# {
- unBigNat :: BigNat#
}
type GmpLimb = Word
type GmpLimb# = Word#
type GmpSize = Int
type GmpSize# = Int#
isValidBigNat# :: BigNat -> Int#
sizeofBigNat# :: BigNat -> GmpSize#
zeroBigNat :: BigNat
oneBigNat :: BigNat
byteArrayToBigNat# :: ByteArray# -> GmpSize# -> BigNat
wordToBigNat :: Word# -> BigNat
wordToBigNat2 :: Word# -> Word# -> BigNat
bigNatToInt :: BigNat -> Int#
bigNatToWord :: BigNat -> Word#
indexBigNat# :: BigNat -> GmpSize# -> GmpLimb#
plusBigNat :: BigNat -> BigNat -> BigNat
plusBigNatWord :: BigNat -> GmpLimb# -> BigNat
minusBigNat :: BigNat -> BigNat -> BigNat
minusBigNatWord :: BigNat -> GmpLimb# -> BigNat
timesBigNat :: BigNat -> BigNat -> BigNat
timesBigNatWord :: BigNat -> GmpLimb# -> BigNat
sqrBigNat :: BigNat -> BigNat
quotRemBigNat :: BigNat -> BigNat -> (# BigNat, BigNat #)
quotRemBigNatWord :: BigNat -> GmpLimb# -> (# BigNat, GmpLimb# #)
quotBigNatWord :: BigNat -> GmpLimb# -> BigNat
quotBigNat :: BigNat -> BigNat -> BigNat
remBigNat :: BigNat -> BigNat -> BigNat
remBigNatWord :: BigNat -> GmpLimb# -> Word#
gcdBigNat :: BigNat -> BigNat -> BigNat
gcdBigNatWord :: BigNat -> Word# -> Word#
shiftRBigNat :: BigNat -> Int# -> BigNat
shiftLBigNat :: BigNat -> Int# -> BigNat
testBitBigNat :: BigNat -> Int# -> Bool
clearBitBigNat :: BigNat -> Int# -> BigNat
complementBitBigNat :: BigNat -> Int# -> BigNat
setBitBigNat :: BigNat -> Int# -> BigNat
andBigNat :: BigNat -> BigNat -> BigNat
xorBigNat :: BigNat -> BigNat -> BigNat
popCountBigNat :: BigNat -> Int#
orBigNat :: BigNat -> BigNat -> BigNat
bitBigNat :: Int# -> BigNat
isZeroBigNat :: BigNat -> Bool
compareBigNatWord :: BigNat -> GmpLimb# -> Ordering
compareBigNat :: BigNat -> BigNat -> Ordering
eqBigNatWord :: BigNat -> GmpLimb# -> Bool
eqBigNatWord# :: BigNat -> GmpLimb# -> Int#
eqBigNat :: BigNat -> BigNat -> Bool
eqBigNat# :: BigNat -> BigNat -> Int#
gtBigNatWord# :: BigNat -> GmpLimb# -> Int#
sizeInBaseBigNat :: BigNat -> Int# -> Word#
sizeInBaseInteger :: Integer -> Int# -> Word#
sizeInBaseWord# :: Word# -> Int# -> Word#
exportBigNatToAddr :: BigNat -> Addr# -> Int# -> IO Word
exportIntegerToAddr :: Integer -> Addr# -> Int# -> IO Word
exportBigNatToMutableByteArray :: BigNat -> MutableByteArray# RealWorld -> Word# -> Int# -> IO Word
exportIntegerToMutableByteArray :: Integer -> MutableByteArray# RealWorld -> Word# -> Int# -> IO Word
importBigNatFromAddr :: Addr# -> Word# -> Int# -> IO BigNat
importIntegerFromAddr :: Addr# -> Word# -> Int# -> IO Integer
importBigNatFromByteArray :: ByteArray# -> Word# -> Word# -> Int# -> BigNat
importIntegerFromByteArray :: ByteArray# -> Word# -> Word# -> Int# -> Integer

The `Integer` type

data Integer where Source #

Arbitrary precision integers. In contrast with fixed-size integral types such as Int, the Integer type represents the entire infinite range of integers.

Integers are stored in a kind of sign-magnitude form, hence do not expect two's complement form when using bit operations.

If the value is small (fit into an Int), IS constructor is used. Otherwise IP and IN constructors are used to store a BigNat representing respectively the positive or the negative value magnitude.

Invariant: IP and IN are used iff value doesn't fit in IS

Bundled Patterns

pattern S# :: Int# -> Integer	Deprecated: Use IS constructor instead
pattern Jn# :: BigNat -> Integer	Deprecated: Use IN constructor instead
pattern Jp# :: BigNat -> Integer	Deprecated: Use IP constructor instead

Instances

Instances details

Show Integer	Since: base-2.1
Instance details Defined in GHC.Show Methods showsPrec :: Int -> Integer -> ShowS Source # show :: Integer -> String Source # showList :: [Integer] -> ShowS Source #
Eq Integer
Instance details Defined in GHC.Num.Integer Methods (==) :: Integer -> Integer -> Bool Source # (/=) :: Integer -> Integer -> Bool Source #
Ord Integer
Instance details Defined in GHC.Num.Integer Methods compare :: Integer -> Integer -> Ordering Source # (<) :: Integer -> Integer -> Bool Source # (<=) :: Integer -> Integer -> Bool Source # (>) :: Integer -> Integer -> Bool Source # (>=) :: Integer -> Integer -> Bool Source # max :: Integer -> Integer -> Integer Source # min :: Integer -> Integer -> Integer Source #

isValidInteger# :: Integer -> Int# Source #

Deprecated: Use integerCheck# instead

Basic `Integer` operations

module GHC.Integer

Additional `Integer` operations

gcdInteger :: Integer -> Integer -> Integer Source #

Deprecated: Use integerGcd instead

gcdExtInteger :: Integer -> Integer -> (# Integer, Integer #) Source #

Deprecated: Use integerGcde instead

lcmInteger :: Integer -> Integer -> Integer Source #

Deprecated: Use integerLcm instead

sqrInteger :: Integer -> Integer Source #

Deprecated: Use integerSqr instead

powModInteger :: Integer -> Integer -> Integer -> Integer Source #

Deprecated: Use integerPowMod# instead

recipModInteger :: Integer -> Integer -> Integer Source #

Deprecated: Use integerRecipMod# instead

Additional conversion operations to `Integer`

wordToNegInteger :: Word# -> Integer Source #

Deprecated: Use integerFromWordNeg# instead

bigNatToInteger :: BigNat -> Integer Source #

Deprecated: Use integerFromBigNat# instead

bigNatToNegInteger :: BigNat -> Integer Source #

Deprecated: Use integerFromBigNatNeg# instead

The `BigNat` type

data BigNat Source #

A lifted BigNat

Represented as an array of limbs (Word#) stored in little-endian order (Word# themselves use machine order).

Invariant (canonical representation): higher Word# is non-zero.

As a consequence, zero is represented with a WordArray# whose size is 0.

Constructors

BN#
Fields unBigNat :: BigNat#

Instances

Instances details

Eq BigNat
Instance details Defined in GHC.Num.BigNat Methods (==) :: BigNat -> BigNat -> Bool Source # (/=) :: BigNat -> BigNat -> Bool Source #
Ord BigNat
Instance details Defined in GHC.Num.BigNat Methods compare :: BigNat -> BigNat -> Ordering Source # (<) :: BigNat -> BigNat -> Bool Source # (<=) :: BigNat -> BigNat -> Bool Source # (>) :: BigNat -> BigNat -> Bool Source # (>=) :: BigNat -> BigNat -> Bool Source # max :: BigNat -> BigNat -> BigNat Source # min :: BigNat -> BigNat -> BigNat Source #