integer-gmp-1.0.0.0: Integer library based on GMP

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

GHC.Integer

Contents

Construct Integers
Conversion to other integral types
Helpers for RealFloat type-class operations
Arithmetic operations
Comparison predicates
- Int#-boolean valued versions of comparision predicates
Bit-operations
Hashing

Description

The Integer type.

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

Synopsis

Documentation

data Integer Source

Invariant: Jn# and Jp# are used iff value doesn't fit in S#

Useful properties resulting from the invariants:

```
abs (S# _) <= abs (Jp# _)
```
```
abs (S# _) <  abs (Jn# _)
```

Instances

Eq Integer
Ord Integer

Construct `Integer`s

mkInteger Source

Arguments

:: Bool	sign of integer (`True` if non-negative)
-> [Int]	absolute value expressed in 31 bit chunks, least significant first (ideally these would be machine-word `Word`s rather than 31-bit truncated `Int`s)
-> Integer

Construct Integer value from list of Ints.

This function is used by GHC for constructing Integer literals.

smallInteger :: Int# -> Integer Source

Should rather be called intToInteger

wordToInteger :: Word# -> Integer Source

Conversion to other integral types

integerToWord :: Integer -> Word# Source

integerToInt :: Integer -> Int# Source

Truncates Integer to least-significant Int#

Helpers for `RealFloat` type-class operations

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

floatFromInteger :: Integer -> Float# Source

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

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

doubleFromInteger :: Integer -> Double# Source

Arithmetic operations

plusInteger :: Integer -> Integer -> Integer Source

Add two Integers

minusInteger :: Integer -> Integer -> Integer Source

Subtract two Integers from each other.

timesInteger :: Integer -> Integer -> Integer Source

Multiply two Integers

negateInteger :: Integer -> Integer Source

Negate Integer

absInteger :: Integer -> Integer Source

Compute absolute value of an Integer

signumInteger :: Integer -> Integer Source

Return -1, 0, and 1 depending on whether argument is negative, zero, or positive, respectively

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

Simultaneous divInteger and modInteger.

Divisor must be non-zero otherwise the GHC runtime will terminate with a division-by-zero fault.

divInteger :: Integer -> Integer -> Integer Source

modInteger :: Integer -> Integer -> Integer Source

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

Simultaneous quotInteger and remInteger.

Divisor must be non-zero otherwise the GHC runtime will terminate with a division-by-zero fault.

quotInteger :: Integer -> Integer -> Integer Source

remInteger :: Integer -> Integer -> Integer Source

Comparison predicates

eqInteger :: Integer -> Integer -> Bool Source

neqInteger :: Integer -> Integer -> Bool Source

Not-equal predicate.

leInteger :: Integer -> Integer -> Bool Source

gtInteger :: Integer -> Integer -> Bool Source

ltInteger :: Integer -> Integer -> Bool Source

geInteger :: Integer -> Integer -> Bool Source

compareInteger :: Integer -> Integer -> Ordering Source

`Int#`-boolean valued versions of comparision predicates

These operations return 0# and 1# instead of False and True respectively. See PrimBool wiki-page for more details

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

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

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

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

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

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

Bit-operations

andInteger :: Integer -> Integer -> Integer Source

Bitwise AND operation

orInteger :: Integer -> Integer -> Integer Source

Bitwise OR operation

xorInteger :: Integer -> Integer -> Integer Source

Bitwise XOR operation

complementInteger :: Integer -> Integer Source

Bitwise NOT operation

shiftLInteger :: Integer -> Int# -> Integer Source

Shift-left operation

Even though the shift-amount is expressed as Int#, the result is undefined for negative shift-amounts.

shiftRInteger :: Integer -> Int# -> Integer Source

Arithmetic shift-right operation

Even though the shift-amount is expressed as Int#, the result is undefined for negative shift-amounts.

testBitInteger :: Integer -> Int# -> Bool Source

Test if n-th bit is set.

Hashing

hashInteger :: Integer -> Int# Source