base-4.8.2.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

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