base-4.8.1.0: Basic libraries

Copyright(C) 2014 Herbert Valerio Riedel, (C) 2011 Edward Kmett
Licensesee libraries/base/LICENSE
Maintainerlibraries@haskell.org
Stabilityinternal
Portabilitynon-portable (GHC Extensions)
Safe HaskellUnsafe
LanguageHaskell2010

GHC.Natural

Contents

Description

The arbitrary-precision Natural number type.

Note: This is an internal GHC module with an API subject to change. It's recommended use the Numeric.Natural module to import the Natural type.

Since: 4.8.0.0

Synopsis

The Natural number type

Warning: The internal implementation of Natural (i.e. which constructors are available) depends on the Integer backend used!

data Natural Source

Type representing arbitrary-precision non-negative integers.

Operations whose result would be negative throw (Underflow :: ArithException).

Since: 4.8.0.0

Constructors

NatS# GmpLimb#

in [0, maxBound::Word]

NatJ# !BigNat

in ]maxBound::Word, +inf[

Invariant: NatJ# is used iff value doesn't fit in NatS# constructor.

Instances

Enum Natural Source 
Eq Natural Source 

Methods

(==) :: Natural -> Natural -> Bool

(/=) :: Natural -> Natural -> Bool

Integral Natural Source 
Data Natural Source 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Natural -> c Natural Source

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Natural Source

toConstr :: Natural -> Constr Source

dataTypeOf :: Natural -> DataType Source

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Natural) Source

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Natural) Source

gmapT :: (forall b. Data b => b -> b) -> Natural -> Natural Source

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Natural -> r Source

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Natural -> r Source

gmapQ :: (forall d. Data d => d -> u) -> Natural -> [u] Source

gmapQi :: Int -> (forall d. Data d => d -> u) -> Natural -> u Source

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Natural -> m Natural Source

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Natural -> m Natural Source

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Natural -> m Natural Source

Num Natural Source 
Ord Natural Source 
Read Natural Source 
Real Natural Source 
Show Natural Source 
Ix Natural Source 
Bits Natural Source 
PrintfArg Natural Source 

isValidNatural :: Natural -> Bool Source

Test whether all internal invariants are satisfied by Natural value

This operation is mostly useful for test-suites and/or code which constructs Integer values directly.

Since: 4.8.0.0

Conversions

wordToNatural :: Word -> Natural Source

Construct Natural from Word value.

Since: 4.8.0.0

naturalToWordMaybe :: Natural -> Maybe Word Source

Try downcasting Natural to Word value. Returns Nothing if value doesn't fit in Word.

Since: 4.8.0.0

Checked subtraction

minusNaturalMaybe :: Natural -> Natural -> Maybe Natural Source

Natural subtraction. Returns Nothings for non-positive results.

Since: 4.8.0.0

Modular arithmetic

powModNatural :: Natural -> Natural -> Natural -> Natural Source

"powModNatural b e m" computes base b raised to exponent e modulo m.

Since: 4.8.0.0