integer-gmp-0.5.1.0: Integer library based on GMP

Copyright | (c) The University of Glasgow 1994-2008
License | see libraries/integer-gmp/LICENSE
Maintainer | cvs-ghc@haskell.org
Stability | internal
Portability | non-portable (GHC Extensions)
Safe Haskell | None
Language | Haskell2010

GHC.Integer

Contents

- Construct `Integer`s
- Conversion to other integral types
- Helpers for `RealFloat` type-class operations
- Arithmetic operations
- Comparison predicates
- Bit-operations
- Hashing

Description

The `Integer` type.

This module exposes the portable `Integer` API. See GHC.Integer.GMP.Internals for the GMP-specific internal representation of `Integer` as well as optimized GMP-specific operations.

Synopsis

- data Integer
- mkInteger :: Bool -> [Int] -> Integer
- smallInteger :: Int# -> Integer
- wordToInteger :: Word# -> Integer
- integerToWord :: Integer -> Word#
- integerToInt :: Integer -> Int#
- encodeFloatInteger :: Integer -> Int# -> Float#
- floatFromInteger :: Integer -> Float#
- encodeDoubleInteger :: Integer -> Int# -> Double#
- decodeDoubleInteger :: Double# -> (#Integer, Int##)
- doubleFromInteger :: Integer -> Double#
- plusInteger :: Integer -> Integer -> Integer
- minusInteger :: Integer -> Integer -> Integer
- timesInteger :: Integer -> Integer -> Integer
- negateInteger :: Integer -> Integer
- absInteger :: Integer -> Integer
- signumInteger :: Integer -> Integer
- divModInteger :: Integer -> Integer -> (#Integer, Integer#)
- divInteger :: Integer -> Integer -> Integer
- modInteger :: Integer -> Integer -> Integer
- quotRemInteger :: Integer -> Integer -> (#Integer, Integer#)
- quotInteger :: Integer -> Integer -> Integer
- remInteger :: Integer -> Integer -> Integer
- eqInteger :: Integer -> Integer -> Bool
- neqInteger :: Integer -> Integer -> Bool
- leInteger :: Integer -> Integer -> Bool
- gtInteger :: Integer -> Integer -> Bool
- ltInteger :: Integer -> Integer -> Bool
- geInteger :: Integer -> Integer -> Bool
- compareInteger :: Integer -> Integer -> Ordering
- eqInteger# :: Integer -> Integer -> Int#
- neqInteger# :: Integer -> Integer -> Int#
- leInteger# :: Integer -> Integer -> Int#
- gtInteger# :: Integer -> Integer -> Int#
- ltInteger# :: Integer -> Integer -> Int#
- geInteger# :: Integer -> Integer -> Int#
- andInteger :: Integer -> Integer -> Integer
- orInteger :: Integer -> Integer -> Integer
- xorInteger :: Integer -> Integer -> Integer
- complementInteger :: Integer -> Integer
- shiftLInteger :: Integer -> Int# -> Integer
- shiftRInteger :: Integer -> Int# -> Integer
- testBitInteger :: Integer -> Int# -> Bool
- hashInteger :: Integer -> Int#

# Documentation

data Integer

Arbitrary-precision integers.

Instances

Eq Integer |
Ord Integer |

# Construct `Integer`s

mkInteger

Arguments

:: Bool | sign of integer (`True` if non-negative)
-> [Int] | absolute value expressed in 31 bit chunks, least significant first
-> Integer |

Construct `Integer` value from list of `Int`s.

This function is used by GHC for constructing `Integer` literals.

smallInteger :: Int# -> Integer

wordToInteger :: Word# -> Integer

# Conversion to other integral types

integerToWord :: Integer -> Word#

integerToInt :: Integer -> Int#

# Helpers for `RealFloat` type-class operations

encodeFloatInteger :: Integer -> Int# -> Float#

floatFromInteger :: Integer -> Float#

encodeDoubleInteger :: Integer -> Int# -> Double#

decodeDoubleInteger :: Double# -> (#Integer, Int##)

doubleFromInteger :: Integer -> Double#

# Arithmetic operations

plusInteger :: Integer -> Integer -> Integer

minusInteger :: Integer -> Integer -> Integer

timesInteger :: Integer -> Integer -> Integer

negateInteger :: Integer -> Integer

absInteger :: Integer -> Integer

signumInteger :: Integer -> Integer

divModInteger :: Integer -> Integer -> (#Integer, Integer#)

divInteger :: Integer -> Integer -> Integer

modInteger :: Integer -> Integer -> Integer

quotRemInteger :: Integer -> Integer -> (#Integer, Integer#)

quotInteger :: Integer -> Integer -> Integer

remInteger :: Integer -> Integer -> Integer

# Comparison predicates

eqInteger :: Integer -> Integer -> Bool

neqInteger :: Integer -> Integer -> Bool

leInteger :: Integer -> Integer -> Bool

gtInteger :: Integer -> Integer -> Bool

ltInteger :: Integer -> Integer -> Bool

geInteger :: Integer -> Integer -> Bool

compareInteger :: Integer -> Integer -> Ordering

eqInteger# :: Integer -> Integer -> Int#

Since: 0.5.1.0

neqInteger# :: Integer -> Integer -> Int#

Since: 0.5.1.0

leInteger# :: Integer -> Integer -> Int#

Since: 0.5.1.0

gtInteger# :: Integer -> Integer -> Int#

Since: 0.5.1.0

ltInteger# :: Integer -> Integer -> Int#

Since: 0.5.1.0

geInteger# :: Integer -> Integer -> Int#

Since: 0.5.1.0

# Bit-operations

andInteger :: Integer -> Integer -> Integer

orInteger :: Integer -> Integer -> Integer

xorInteger :: Integer -> Integer -> Integer

complementInteger :: Integer -> Integer

shiftLInteger :: Integer -> Int# -> Integer

shiftRInteger :: Integer -> Int# -> Integer

testBitInteger :: Integer -> Int# -> Bool

Since: 0.5.1.0

# Hashing

hashInteger :: Integer -> Int#

`hashInteger` returns the same value as `fromIntegral`, although in unboxed form. It might be a reasonable hash function for `Integer`, given a suitable distribution of `Integer` values.

Note: `hashInteger` is currently just an alias for `integerToInt`.